home *** CD-ROM | disk | FTP | other *** search
/ Chip 2007 January, February, March & April / Chip-Cover-CD-2007-02.iso / Pakiet bezpieczenstwa / mini Pentoo LiveCD 2006.1 / mpentoo-2006.1.iso / livecd.squashfs / usr / share / binutils-data / i686-pc-linux-gnu / 2.16.1 / info / ld.info < prev   
Text File  |  2006-01-09  |  289KB  |  6,315 lines

  1. This is ld.info, produced by makeinfo version 4.8 from
  2. /var/tmp/portage/binutils-2.16.1/work/binutils-2.16.1/ld/ld.texinfo.
  3.  
  4. START-INFO-DIR-ENTRY
  5. * Ld: (ld).                       The GNU linker.
  6. END-INFO-DIR-ENTRY
  7.  
  8.    This file documents the GNU linker LD version 2.16.1.
  9.  
  10.    Copyright (C) 1991, 92, 93, 94, 95, 96, 97, 98, 99, 2000, 2001,
  11. 2002, 2003, 2004 Free Software Foundation, Inc.
  12.  
  13. 
  14. File: ld.info,  Node: Top,  Next: Overview,  Up: (dir)
  15.  
  16. Using ld
  17. ********
  18.  
  19. This file documents the GNU linker ld version 2.16.1.
  20.  
  21.    This document is distributed under the terms of the GNU Free
  22. Documentation License.  A copy of the license is included in the
  23. section entitled "GNU Free Documentation License".
  24.  
  25. * Menu:
  26.  
  27. * Overview::                    Overview
  28. * Invocation::                  Invocation
  29. * Scripts::                     Linker Scripts
  30.  
  31. * Machine Dependent::           Machine Dependent Features
  32.  
  33. * BFD::                         BFD
  34.  
  35. * Reporting Bugs::              Reporting Bugs
  36. * MRI::                         MRI Compatible Script Files
  37. * GNU Free Documentation License::  GNU Free Documentation License
  38. * Index::                       Index
  39.  
  40. 
  41. File: ld.info,  Node: Overview,  Next: Invocation,  Prev: Top,  Up: Top
  42.  
  43. 1 Overview
  44. **********
  45.  
  46. `ld' combines a number of object and archive files, relocates their
  47. data and ties up symbol references. Usually the last step in compiling
  48. a program is to run `ld'.
  49.  
  50.    `ld' accepts Linker Command Language files written in a superset of
  51. AT&T's Link Editor Command Language syntax, to provide explicit and
  52. total control over the linking process.
  53.  
  54.    This version of `ld' uses the general purpose BFD libraries to
  55. operate on object files. This allows `ld' to read, combine, and write
  56. object files in many different formats--for example, COFF or `a.out'.
  57. Different formats may be linked together to produce any available kind
  58. of object file.  *Note BFD::, for more information.
  59.  
  60.    Aside from its flexibility, the GNU linker is more helpful than other
  61. linkers in providing diagnostic information.  Many linkers abandon
  62. execution immediately upon encountering an error; whenever possible,
  63. `ld' continues executing, allowing you to identify other errors (or, in
  64. some cases, to get an output file in spite of the error).
  65.  
  66. 
  67. File: ld.info,  Node: Invocation,  Next: Scripts,  Prev: Overview,  Up: Top
  68.  
  69. 2 Invocation
  70. ************
  71.  
  72. The GNU linker `ld' is meant to cover a broad range of situations, and
  73. to be as compatible as possible with other linkers.  As a result, you
  74. have many choices to control its behavior.
  75.  
  76. * Menu:
  77.  
  78. * Options::                     Command Line Options
  79. * Environment::                 Environment Variables
  80.  
  81. 
  82. File: ld.info,  Node: Options,  Next: Environment,  Up: Invocation
  83.  
  84. 2.1 Command Line Options
  85. ========================
  86.  
  87.    The linker supports a plethora of command-line options, but in actual
  88. practice few of them are used in any particular context.  For instance,
  89. a frequent use of `ld' is to link standard Unix object files on a
  90. standard, supported Unix system.  On such a system, to link a file
  91. `hello.o':
  92.  
  93.      ld -o OUTPUT /lib/crt0.o hello.o -lc
  94.  
  95.    This tells `ld' to produce a file called OUTPUT as the result of
  96. linking the file `/lib/crt0.o' with `hello.o' and the library `libc.a',
  97. which will come from the standard search directories.  (See the
  98. discussion of the `-l' option below.)
  99.  
  100.    Some of the command-line options to `ld' may be specified at any
  101. point in the command line.  However, options which refer to files, such
  102. as `-l' or `-T', cause the file to be read at the point at which the
  103. option appears in the command line, relative to the object files and
  104. other file options.  Repeating non-file options with a different
  105. argument will either have no further effect, or override prior
  106. occurrences (those further to the left on the command line) of that
  107. option.  Options which may be meaningfully specified more than once are
  108. noted in the descriptions below.
  109.  
  110.    Non-option arguments are object files or archives which are to be
  111. linked together.  They may follow, precede, or be mixed in with
  112. command-line options, except that an object file argument may not be
  113. placed between an option and its argument.
  114.  
  115.    Usually the linker is invoked with at least one object file, but you
  116. can specify other forms of binary input files using `-l', `-R', and the
  117. script command language.  If _no_ binary input files at all are
  118. specified, the linker does not produce any output, and issues the
  119. message `No input files'.
  120.  
  121.    If the linker cannot recognize the format of an object file, it will
  122. assume that it is a linker script.  A script specified in this way
  123. augments the main linker script used for the link (either the default
  124. linker script or the one specified by using `-T').  This feature
  125. permits the linker to link against a file which appears to be an object
  126. or an archive, but actually merely defines some symbol values, or uses
  127. `INPUT' or `GROUP' to load other objects.  Note that specifying a
  128. script in this way merely augments the main linker script; use the `-T'
  129. option to replace the default linker script entirely.  *Note Scripts::.
  130.  
  131.    For options whose names are a single letter, option arguments must
  132. either follow the option letter without intervening whitespace, or be
  133. given as separate arguments immediately following the option that
  134. requires them.
  135.  
  136.    For options whose names are multiple letters, either one dash or two
  137. can precede the option name; for example, `-trace-symbol' and
  138. `--trace-symbol' are equivalent.  Note--there is one exception to this
  139. rule.  Multiple letter options that start with a lower case 'o' can
  140. only be preceeded by two dashes.  This is to reduce confusion with the
  141. `-o' option.  So for example `-omagic' sets the output file name to
  142. `magic' whereas `--omagic' sets the NMAGIC flag on the output.
  143.  
  144.    Arguments to multiple-letter options must either be separated from
  145. the option name by an equals sign, or be given as separate arguments
  146. immediately following the option that requires them.  For example,
  147. `--trace-symbol foo' and `--trace-symbol=foo' are equivalent.  Unique
  148. abbreviations of the names of multiple-letter options are accepted.
  149.  
  150.    Note--if the linker is being invoked indirectly, via a compiler
  151. driver (e.g. `gcc') then all the linker command line options should be
  152. prefixed by `-Wl,' (or whatever is appropriate for the particular
  153. compiler driver) like this:
  154.  
  155.        gcc -Wl,--startgroup foo.o bar.o -Wl,--endgroup
  156.  
  157.    This is important, because otherwise the compiler driver program may
  158. silently drop the linker options, resulting in a bad link.
  159.  
  160.    Here is a table of the generic command line switches accepted by the
  161. GNU linker:
  162.  
  163. `-aKEYWORD'
  164.      This option is supported for HP/UX compatibility.  The KEYWORD
  165.      argument must be one of the strings `archive', `shared', or
  166.      `default'.  `-aarchive' is functionally equivalent to `-Bstatic',
  167.      and the other two keywords are functionally equivalent to
  168.      `-Bdynamic'.  This option may be used any number of times.
  169.  
  170. `-AARCHITECTURE'
  171. `--architecture=ARCHITECTURE'
  172.      In the current release of `ld', this option is useful only for the
  173.      Intel 960 family of architectures.  In that `ld' configuration, the
  174.      ARCHITECTURE argument identifies the particular architecture in
  175.      the 960 family, enabling some safeguards and modifying the
  176.      archive-library search path.  *Note `ld' and the Intel 960 family:
  177.      i960, for details.
  178.  
  179.      Future releases of `ld' may support similar functionality for
  180.      other architecture families.
  181.  
  182. `-b INPUT-FORMAT'
  183. `--format=INPUT-FORMAT'
  184.      `ld' may be configured to support more than one kind of object
  185.      file.  If your `ld' is configured this way, you can use the `-b'
  186.      option to specify the binary format for input object files that
  187.      follow this option on the command line.  Even when `ld' is
  188.      configured to support alternative object formats, you don't
  189.      usually need to specify this, as `ld' should be configured to
  190.      expect as a default input format the most usual format on each
  191.      machine.  INPUT-FORMAT is a text string, the name of a particular
  192.      format supported by the BFD libraries.  (You can list the
  193.      available binary formats with `objdump -i'.)  *Note BFD::.
  194.  
  195.      You may want to use this option if you are linking files with an
  196.      unusual binary format.  You can also use `-b' to switch formats
  197.      explicitly (when linking object files of different formats), by
  198.      including `-b INPUT-FORMAT' before each group of object files in a
  199.      particular format.
  200.  
  201.      The default format is taken from the environment variable
  202.      `GNUTARGET'.  *Note Environment::.  You can also define the input
  203.      format from a script, using the command `TARGET'; see *Note Format
  204.      Commands::.
  205.  
  206. `-c MRI-COMMANDFILE'
  207. `--mri-script=MRI-COMMANDFILE'
  208.      For compatibility with linkers produced by MRI, `ld' accepts script
  209.      files written in an alternate, restricted command language,
  210.      described in *Note MRI Compatible Script Files: MRI.  Introduce
  211.      MRI script files with the option `-c'; use the `-T' option to run
  212.      linker scripts written in the general-purpose `ld' scripting
  213.      language.  If MRI-CMDFILE does not exist, `ld' looks for it in the
  214.      directories specified by any `-L' options.
  215.  
  216. `-d'
  217. `-dc'
  218. `-dp'
  219.      These three options are equivalent; multiple forms are supported
  220.      for compatibility with other linkers.  They assign space to common
  221.      symbols even if a relocatable output file is specified (with
  222.      `-r').  The script command `FORCE_COMMON_ALLOCATION' has the same
  223.      effect.  *Note Miscellaneous Commands::.
  224.  
  225. `-e ENTRY'
  226. `--entry=ENTRY'
  227.      Use ENTRY as the explicit symbol for beginning execution of your
  228.      program, rather than the default entry point.  If there is no
  229.      symbol named ENTRY, the linker will try to parse ENTRY as a number,
  230.      and use that as the entry address (the number will be interpreted
  231.      in base 10; you may use a leading `0x' for base 16, or a leading
  232.      `0' for base 8).  *Note Entry Point::, for a discussion of defaults
  233.      and other ways of specifying the entry point.
  234.  
  235. `--exclude-libs LIB,LIB,...'
  236.      Specifies a list of archive libraries from which symbols should
  237.      not be automatically exported. The library names may be delimited
  238.      by commas or colons.  Specifying `--exclude-libs ALL' excludes
  239.      symbols in all archive libraries from automatic export.  This
  240.      option is available only for the i386 PE targeted port of the
  241.      linker and for ELF targeted ports.  For i386 PE, symbols
  242.      explicitly listed in a .def file are still exported, regardless of
  243.      this option.  For ELF targeted ports, symbols affected by this
  244.      option will be treated as hidden.
  245.  
  246. `-E'
  247. `--export-dynamic'
  248.      When creating a dynamically linked executable, add all symbols to
  249.      the dynamic symbol table.  The dynamic symbol table is the set of
  250.      symbols which are visible from dynamic objects at run time.
  251.  
  252.      If you do not use this option, the dynamic symbol table will
  253.      normally contain only those symbols which are referenced by some
  254.      dynamic object mentioned in the link.
  255.  
  256.      If you use `dlopen' to load a dynamic object which needs to refer
  257.      back to the symbols defined by the program, rather than some other
  258.      dynamic object, then you will probably need to use this option when
  259.      linking the program itself.
  260.  
  261.      You can also use the version script to control what symbols should
  262.      be added to the dynamic symbol table if the output format supports
  263.      it.  See the description of `--version-script' in *Note VERSION::.
  264.  
  265. `-EB'
  266.      Link big-endian objects.  This affects the default output format.
  267.  
  268. `-EL'
  269.      Link little-endian objects.  This affects the default output
  270.      format.
  271.  
  272. `-f'
  273. `--auxiliary NAME'
  274.      When creating an ELF shared object, set the internal DT_AUXILIARY
  275.      field to the specified name.  This tells the dynamic linker that
  276.      the symbol table of the shared object should be used as an
  277.      auxiliary filter on the symbol table of the shared object NAME.
  278.  
  279.      If you later link a program against this filter object, then, when
  280.      you run the program, the dynamic linker will see the DT_AUXILIARY
  281.      field.  If the dynamic linker resolves any symbols from the filter
  282.      object, it will first check whether there is a definition in the
  283.      shared object NAME.  If there is one, it will be used instead of
  284.      the definition in the filter object.  The shared object NAME need
  285.      not exist.  Thus the shared object NAME may be used to provide an
  286.      alternative implementation of certain functions, perhaps for
  287.      debugging or for machine specific performance.
  288.  
  289.      This option may be specified more than once.  The DT_AUXILIARY
  290.      entries will be created in the order in which they appear on the
  291.      command line.
  292.  
  293. `-F NAME'
  294. `--filter NAME'
  295.      When creating an ELF shared object, set the internal DT_FILTER
  296.      field to the specified name.  This tells the dynamic linker that
  297.      the symbol table of the shared object which is being created
  298.      should be used as a filter on the symbol table of the shared
  299.      object NAME.
  300.  
  301.      If you later link a program against this filter object, then, when
  302.      you run the program, the dynamic linker will see the DT_FILTER
  303.      field.  The dynamic linker will resolve symbols according to the
  304.      symbol table of the filter object as usual, but it will actually
  305.      link to the definitions found in the shared object NAME.  Thus the
  306.      filter object can be used to select a subset of the symbols
  307.      provided by the object NAME.
  308.  
  309.      Some older linkers used the `-F' option throughout a compilation
  310.      toolchain for specifying object-file format for both input and
  311.      output object files.  The GNU linker uses other mechanisms for
  312.      this purpose: the `-b', `--format', `--oformat' options, the
  313.      `TARGET' command in linker scripts, and the `GNUTARGET'
  314.      environment variable.  The GNU linker will ignore the `-F' option
  315.      when not creating an ELF shared object.
  316.  
  317. `-fini NAME'
  318.      When creating an ELF executable or shared object, call NAME when
  319.      the executable or shared object is unloaded, by setting DT_FINI to
  320.      the address of the function.  By default, the linker uses `_fini'
  321.      as the function to call.
  322.  
  323. `-g'
  324.      Ignored.  Provided for compatibility with other tools.
  325.  
  326. `-GVALUE'
  327. `--gpsize=VALUE'
  328.      Set the maximum size of objects to be optimized using the GP
  329.      register to SIZE.  This is only meaningful for object file formats
  330.      such as MIPS ECOFF which supports putting large and small objects
  331.      into different sections.  This is ignored for other object file
  332.      formats.
  333.  
  334. `-hNAME'
  335. `-soname=NAME'
  336.      When creating an ELF shared object, set the internal DT_SONAME
  337.      field to the specified name.  When an executable is linked with a
  338.      shared object which has a DT_SONAME field, then when the
  339.      executable is run the dynamic linker will attempt to load the
  340.      shared object specified by the DT_SONAME field rather than the
  341.      using the file name given to the linker.
  342.  
  343. `-i'
  344.      Perform an incremental link (same as option `-r').
  345.  
  346. `-init NAME'
  347.      When creating an ELF executable or shared object, call NAME when
  348.      the executable or shared object is loaded, by setting DT_INIT to
  349.      the address of the function.  By default, the linker uses `_init'
  350.      as the function to call.
  351.  
  352. `-lARCHIVE'
  353. `--library=ARCHIVE'
  354.      Add archive file ARCHIVE to the list of files to link.  This
  355.      option may be used any number of times.  `ld' will search its
  356.      path-list for occurrences of `libARCHIVE.a' for every ARCHIVE
  357.      specified.
  358.  
  359.      On systems which support shared libraries, `ld' may also search for
  360.      libraries with extensions other than `.a'.  Specifically, on ELF
  361.      and SunOS systems, `ld' will search a directory for a library with
  362.      an extension of `.so' before searching for one with an extension of
  363.      `.a'.  By convention, a `.so' extension indicates a shared library.
  364.  
  365.      The linker will search an archive only once, at the location where
  366.      it is specified on the command line.  If the archive defines a
  367.      symbol which was undefined in some object which appeared before
  368.      the archive on the command line, the linker will include the
  369.      appropriate file(s) from the archive.  However, an undefined
  370.      symbol in an object appearing later on the command line will not
  371.      cause the linker to search the archive again.
  372.  
  373.      See the `-(' option for a way to force the linker to search
  374.      archives multiple times.
  375.  
  376.      You may list the same archive multiple times on the command line.
  377.  
  378.      This type of archive searching is standard for Unix linkers.
  379.      However, if you are using `ld' on AIX, note that it is different
  380.      from the behaviour of the AIX linker.
  381.  
  382. `-LSEARCHDIR'
  383. `--library-path=SEARCHDIR'
  384.      Add path SEARCHDIR to the list of paths that `ld' will search for
  385.      archive libraries and `ld' control scripts.  You may use this
  386.      option any number of times.  The directories are searched in the
  387.      order in which they are specified on the command line.
  388.      Directories specified on the command line are searched before the
  389.      default directories.  All `-L' options apply to all `-l' options,
  390.      regardless of the order in which the options appear.
  391.  
  392.      If SEARCHDIR begins with `=', then the `=' will be replaced by the
  393.      "sysroot prefix", a path specified when the linker is configured.
  394.  
  395.      The default set of paths searched (without being specified with
  396.      `-L') depends on which emulation mode `ld' is using, and in some
  397.      cases also on how it was configured.  *Note Environment::.
  398.  
  399.      The paths can also be specified in a link script with the
  400.      `SEARCH_DIR' command.  Directories specified this way are searched
  401.      at the point in which the linker script appears in the command
  402.      line.
  403.  
  404. `-mEMULATION'
  405.      Emulate the EMULATION linker.  You can list the available
  406.      emulations with the `--verbose' or `-V' options.
  407.  
  408.      If the `-m' option is not used, the emulation is taken from the
  409.      `LDEMULATION' environment variable, if that is defined.
  410.  
  411.      Otherwise, the default emulation depends upon how the linker was
  412.      configured.
  413.  
  414. `-M'
  415. `--print-map'
  416.      Print a link map to the standard output.  A link map provides
  417.      information about the link, including the following:
  418.  
  419.         * Where object files and symbols are mapped into memory.
  420.  
  421.         * How common symbols are allocated.
  422.  
  423.         * All archive members included in the link, with a mention of
  424.           the symbol which caused the archive member to be brought in.
  425.  
  426. `-n'
  427. `--nmagic'
  428.      Turn off page alignment of sections, and mark the output as
  429.      `NMAGIC' if possible.
  430.  
  431. `-N'
  432. `--omagic'
  433.      Set the text and data sections to be readable and writable.  Also,
  434.      do not page-align the data segment, and disable linking against
  435.      shared libraries.  If the output format supports Unix style magic
  436.      numbers, mark the output as `OMAGIC'. Note: Although a writable
  437.      text section is allowed for PE-COFF targets, it does not conform
  438.      to the format specification published by Microsoft.
  439.  
  440. `--no-omagic'
  441.      This option negates most of the effects of the `-N' option.  It
  442.      sets the text section to be read-only, and forces the data segment
  443.      to be page-aligned.  Note - this option does not enable linking
  444.      against shared libraries.  Use `-Bdynamic' for this.
  445.  
  446. `-o OUTPUT'
  447. `--output=OUTPUT'
  448.      Use OUTPUT as the name for the program produced by `ld'; if this
  449.      option is not specified, the name `a.out' is used by default.  The
  450.      script command `OUTPUT' can also specify the output file name.
  451.  
  452. `-O LEVEL'
  453.      If LEVEL is a numeric values greater than zero `ld' optimizes the
  454.      output.  This might take significantly longer and therefore
  455.      probably should only be enabled for the final binary.
  456.  
  457. `-q'
  458. `--emit-relocs'
  459.      Leave relocation sections and contents in fully linked
  460.      exececutables.  Post link analysis and optimization tools may need
  461.      this information in order to perform correct modifications of
  462.      executables.  This results in larger executables.
  463.  
  464.      This option is currently only supported on ELF platforms.
  465.  
  466. `-r'
  467. `--relocatable'
  468.      Generate relocatable output--i.e., generate an output file that
  469.      can in turn serve as input to `ld'.  This is often called "partial
  470.      linking".  As a side effect, in environments that support standard
  471.      Unix magic numbers, this option also sets the output file's magic
  472.      number to `OMAGIC'.  If this option is not specified, an absolute
  473.      file is produced.  When linking C++ programs, this option _will
  474.      not_ resolve references to constructors; to do that, use `-Ur'.
  475.  
  476.      When an input file does not have the same format as the output
  477.      file, partial linking is only supported if that input file does
  478.      not contain any relocations.  Different output formats can have
  479.      further restrictions; for example some `a.out'-based formats do
  480.      not support partial linking with input files in other formats at
  481.      all.
  482.  
  483.      This option does the same thing as `-i'.
  484.  
  485. `-R FILENAME'
  486. `--just-symbols=FILENAME'
  487.      Read symbol names and their addresses from FILENAME, but do not
  488.      relocate it or include it in the output.  This allows your output
  489.      file to refer symbolically to absolute locations of memory defined
  490.      in other programs.  You may use this option more than once.
  491.  
  492.      For compatibility with other ELF linkers, if the `-R' option is
  493.      followed by a directory name, rather than a file name, it is
  494.      treated as the `-rpath' option.
  495.  
  496. `-s'
  497. `--strip-all'
  498.      Omit all symbol information from the output file.
  499.  
  500. `-S'
  501. `--strip-debug'
  502.      Omit debugger symbol information (but not all symbols) from the
  503.      output file.
  504.  
  505. `-t'
  506. `--trace'
  507.      Print the names of the input files as `ld' processes them.
  508.  
  509. `-T SCRIPTFILE'
  510. `--script=SCRIPTFILE'
  511.      Use SCRIPTFILE as the linker script.  This script replaces `ld''s
  512.      default linker script (rather than adding to it), so COMMANDFILE
  513.      must specify everything necessary to describe the output file.
  514.      *Note Scripts::.  If SCRIPTFILE does not exist in the current
  515.      directory, `ld' looks for it in the directories specified by any
  516.      preceding `-L' options.  Multiple `-T' options accumulate.
  517.  
  518. `-u SYMBOL'
  519. `--undefined=SYMBOL'
  520.      Force SYMBOL to be entered in the output file as an undefined
  521.      symbol.  Doing this may, for example, trigger linking of additional
  522.      modules from standard libraries.  `-u' may be repeated with
  523.      different option arguments to enter additional undefined symbols.
  524.      This option is equivalent to the `EXTERN' linker script command.
  525.  
  526. `-Ur'
  527.      For anything other than C++ programs, this option is equivalent to
  528.      `-r': it generates relocatable output--i.e., an output file that
  529.      can in turn serve as input to `ld'.  When linking C++ programs,
  530.      `-Ur' _does_ resolve references to constructors, unlike `-r'.  It
  531.      does not work to use `-Ur' on files that were themselves linked
  532.      with `-Ur'; once the constructor table has been built, it cannot
  533.      be added to.  Use `-Ur' only for the last partial link, and `-r'
  534.      for the others.
  535.  
  536. `--unique[=SECTION]'
  537.      Creates a separate output section for every input section matching
  538.      SECTION, or if the optional wildcard SECTION argument is missing,
  539.      for every orphan input section.  An orphan section is one not
  540.      specifically mentioned in a linker script.  You may use this option
  541.      multiple times on the command line;  It prevents the normal
  542.      merging of input sections with the same name, overriding output
  543.      section assignments in a linker script.
  544.  
  545. `-v'
  546. `--version'
  547. `-V'
  548.      Display the version number for `ld'.  The `-V' option also lists
  549.      the supported emulations.
  550.  
  551. `-x'
  552. `--discard-all'
  553.      Delete all local symbols.
  554.  
  555. `-X'
  556. `--discard-locals'
  557.      Delete all temporary local symbols.  For most targets, this is all
  558.      local symbols whose names begin with `L'.
  559.  
  560. `-y SYMBOL'
  561. `--trace-symbol=SYMBOL'
  562.      Print the name of each linked file in which SYMBOL appears.  This
  563.      option may be given any number of times.  On many systems it is
  564.      necessary to prepend an underscore.
  565.  
  566.      This option is useful when you have an undefined symbol in your
  567.      link but don't know where the reference is coming from.
  568.  
  569. `-Y PATH'
  570.      Add PATH to the default library search path.  This option exists
  571.      for Solaris compatibility.
  572.  
  573. `-z KEYWORD'
  574.      The recognized keywords are:
  575.     `combreloc'
  576.           Combines multiple reloc sections and sorts them to make
  577.           dynamic symbol lookup caching possible.
  578.  
  579.     `defs'
  580.           Disallows undefined symbols in object files.  Undefined
  581.           symbols in shared libraries are still allowed.
  582.  
  583.     `initfirst'
  584.           This option is only meaningful when building a shared object.
  585.           It marks the object so that its runtime initialization will
  586.           occur before the runtime initialization of any other objects
  587.           brought into the process at the same time.  Similarly the
  588.           runtime finalization of the object will occur after the
  589.           runtime finalization of any other objects.
  590.  
  591.     `interpose'
  592.           Marks the object that its symbol table interposes before all
  593.           symbols but the primary executable.
  594.  
  595.     `loadfltr'
  596.           Marks  the object that its filters be processed immediately at
  597.           runtime.
  598.  
  599.     `muldefs'
  600.           Allows multiple definitions.
  601.  
  602.     `nocombreloc'
  603.           Disables multiple reloc sections combining.
  604.  
  605.     `nocopyreloc'
  606.           Disables production of copy relocs.
  607.  
  608.     `nodefaultlib'
  609.           Marks the object that the search for dependencies of this
  610.           object will ignore any default library search paths.
  611.  
  612.     `nodelete'
  613.           Marks the object shouldn't be unloaded at runtime.
  614.  
  615.     `nodlopen'
  616.           Marks the object not available to `dlopen'.
  617.  
  618.     `nodump'
  619.           Marks the object can not be dumped by `dldump'.
  620.  
  621.     `now'
  622.           When generating an executable or shared library, mark it to
  623.           tell the dynamic linker to resolve all symbols when the
  624.           program is started, or when the shared library is linked to
  625.           using dlopen, instead of deferring function call resolution
  626.           to the point when the function is first called.
  627.  
  628.     `origin'
  629.           Marks the object may contain $ORIGIN.
  630.  
  631.  
  632.      Other keywords are ignored for Solaris compatibility.
  633.  
  634. `-( ARCHIVES -)'
  635. `--start-group ARCHIVES --end-group'
  636.      The ARCHIVES should be a list of archive files.  They may be
  637.      either explicit file names, or `-l' options.
  638.  
  639.      The specified archives are searched repeatedly until no new
  640.      undefined references are created.  Normally, an archive is
  641.      searched only once in the order that it is specified on the
  642.      command line.  If a symbol in that archive is needed to resolve an
  643.      undefined symbol referred to by an object in an archive that
  644.      appears later on the command line, the linker would not be able to
  645.      resolve that reference.  By grouping the archives, they all be
  646.      searched repeatedly until all possible references are resolved.
  647.  
  648.      Using this option has a significant performance cost.  It is best
  649.      to use it only when there are unavoidable circular references
  650.      between two or more archives.
  651.  
  652. `--accept-unknown-input-arch'
  653. `--no-accept-unknown-input-arch'
  654.      Tells the linker to accept input files whose architecture cannot be
  655.      recognised.  The assumption is that the user knows what they are
  656.      doing and deliberately wants to link in these unknown input files.
  657.      This was the default behaviour of the linker, before release
  658.      2.14.  The default behaviour from release 2.14 onwards is to
  659.      reject such input files, and so the `--accept-unknown-input-arch'
  660.      option has been added to restore the old behaviour.
  661.  
  662. `--as-needed'
  663. `--no-as-needed'
  664.      This option affects ELF DT_NEEDED tags for dynamic libraries
  665.      mentioned on the command line after the `--as-needed' option.
  666.      Normally, the linker will add a DT_NEEDED tag for each dynamic
  667.      library mentioned on the command line, regardless of whether the
  668.      library is actually needed.  `--as-needed' causes DT_NEEDED tags
  669.      to only be emitted for libraries that satisfy some symbol
  670.      reference from regular objects which is undefined at the point
  671.      that the library was linked.  `--no-as-needed' restores the
  672.      default behaviour.
  673.  
  674. `--add-needed'
  675. `--no-add-needed'
  676.      This option affects the treatment of dynamic libraries from ELF
  677.      DT_NEEDED tags in dynamic libraries mentioned on the command line
  678.      after the `--no-add-needed' option.  Normally, the linker will add
  679.      a DT_NEEDED tag for each dynamic library from DT_NEEDED tags.
  680.      `--no-add-needed' causes DT_NEEDED tags will never be emitted for
  681.      those libraries from DT_NEEDED tags. `--add-needed' restores the
  682.      default behaviour.
  683.  
  684. `-assert KEYWORD'
  685.      This option is ignored for SunOS compatibility.
  686.  
  687. `-Bdynamic'
  688. `-dy'
  689. `-call_shared'
  690.      Link against dynamic libraries.  This is only meaningful on
  691.      platforms for which shared libraries are supported.  This option
  692.      is normally the default on such platforms.  The different variants
  693.      of this option are for compatibility with various systems.  You
  694.      may use this option multiple times on the command line: it affects
  695.      library searching for `-l' options which follow it.
  696.  
  697. `-Bgroup'
  698.      Set the `DF_1_GROUP' flag in the `DT_FLAGS_1' entry in the dynamic
  699.      section.  This causes the runtime linker to handle lookups in this
  700.      object and its dependencies to be performed only inside the group.
  701.      `--unresolved-symbols=report-all' is implied.  This option is only
  702.      meaningful on ELF platforms which support shared libraries.
  703.  
  704. `-Bstatic'
  705. `-dn'
  706. `-non_shared'
  707. `-static'
  708.      Do not link against shared libraries.  This is only meaningful on
  709.      platforms for which shared libraries are supported.  The different
  710.      variants of this option are for compatibility with various
  711.      systems.  You may use this option multiple times on the command
  712.      line: it affects library searching for `-l' options which follow
  713.      it.  This option also implies `--unresolved-symbols=report-all'.
  714.  
  715. `-Bsymbolic'
  716.      When creating a shared library, bind references to global symbols
  717.      to the definition within the shared library, if any.  Normally, it
  718.      is possible for a program linked against a shared library to
  719.      override the definition within the shared library.  This option is
  720.      only meaningful on ELF platforms which support shared libraries.
  721.  
  722. `--check-sections'
  723. `--no-check-sections'
  724.      Asks the linker _not_ to check section addresses after they have
  725.      been assigned to see if there any overlaps.  Normally the linker
  726.      will perform this check, and if it finds any overlaps it will
  727.      produce suitable error messages.  The linker does know about, and
  728.      does make allowances for sections in overlays.  The default
  729.      behaviour can be restored by using the command line switch
  730.      `--check-sections'.
  731.  
  732. `--cref'
  733.      Output a cross reference table.  If a linker map file is being
  734.      generated, the cross reference table is printed to the map file.
  735.      Otherwise, it is printed on the standard output.
  736.  
  737.      The format of the table is intentionally simple, so that it may be
  738.      easily processed by a script if necessary.  The symbols are
  739.      printed out, sorted by name.  For each symbol, a list of file
  740.      names is given.  If the symbol is defined, the first file listed
  741.      is the location of the definition.  The remaining files contain
  742.      references to the symbol.
  743.  
  744. `--no-define-common'
  745.      This option inhibits the assignment of addresses to common symbols.
  746.      The script command `INHIBIT_COMMON_ALLOCATION' has the same effect.
  747.      *Note Miscellaneous Commands::.
  748.  
  749.      The `--no-define-common' option allows decoupling the decision to
  750.      assign addresses to Common symbols from the choice of the output
  751.      file type; otherwise a non-Relocatable output type forces
  752.      assigning addresses to Common symbols.  Using `--no-define-common'
  753.      allows Common symbols that are referenced from a shared library to
  754.      be assigned addresses only in the main program.  This eliminates
  755.      the unused duplicate space in the shared library, and also
  756.      prevents any possible confusion over resolving to the wrong
  757.      duplicate when there are many dynamic modules with specialized
  758.      search paths for runtime symbol resolution.
  759.  
  760. `--defsym SYMBOL=EXPRESSION'
  761.      Create a global symbol in the output file, containing the absolute
  762.      address given by EXPRESSION.  You may use this option as many
  763.      times as necessary to define multiple symbols in the command line.
  764.      A limited form of arithmetic is supported for the EXPRESSION in
  765.      this context: you may give a hexadecimal constant or the name of
  766.      an existing symbol, or use `+' and `-' to add or subtract
  767.      hexadecimal constants or symbols.  If you need more elaborate
  768.      expressions, consider using the linker command language from a
  769.      script (*note Assignment: Symbol Definitions: Assignments.).
  770.      _Note:_ there should be no white space between SYMBOL, the equals
  771.      sign ("<=>"), and EXPRESSION.
  772.  
  773. `--demangle[=STYLE]'
  774. `--no-demangle'
  775.      These options control whether to demangle symbol names in error
  776.      messages and other output.  When the linker is told to demangle,
  777.      it tries to present symbol names in a readable fashion: it strips
  778.      leading underscores if they are used by the object file format,
  779.      and converts C++ mangled symbol names into user readable names.
  780.      Different compilers have different mangling styles.  The optional
  781.      demangling style argument can be used to choose an appropriate
  782.      demangling style for your compiler.  The linker will demangle by
  783.      default unless the environment variable `COLLECT_NO_DEMANGLE' is
  784.      set.  These options may be used to override the default.
  785.  
  786. `--dynamic-linker FILE'
  787.      Set the name of the dynamic linker.  This is only meaningful when
  788.      generating dynamically linked ELF executables.  The default dynamic
  789.      linker is normally correct; don't use this unless you know what
  790.      you are doing.
  791.  
  792. `--fatal-warnings'
  793.      Treat all warnings as errors.
  794.  
  795. `--force-exe-suffix'
  796.      Make sure that an output file has a .exe suffix.
  797.  
  798.      If a successfully built fully linked output file does not have a
  799.      `.exe' or `.dll' suffix, this option forces the linker to copy the
  800.      output file to one of the same name with a `.exe' suffix. This
  801.      option is useful when using unmodified Unix makefiles on a
  802.      Microsoft Windows host, since some versions of Windows won't run
  803.      an image unless it ends in a `.exe' suffix.
  804.  
  805. `--no-gc-sections'
  806. `--gc-sections'
  807.      Enable garbage collection of unused input sections.  It is ignored
  808.      on targets that do not support this option.  This option is not
  809.      compatible with `-r'. The default behaviour (of not performing
  810.      this garbage collection) can be restored by specifying
  811.      `--no-gc-sections' on the command line.
  812.  
  813. `--help'
  814.      Print a summary of the command-line options on the standard output
  815.      and exit.
  816.  
  817. `--target-help'
  818.      Print a summary of all target specific options on the standard
  819.      output and exit.
  820.  
  821. `-Map MAPFILE'
  822.      Print a link map to the file MAPFILE.  See the description of the
  823.      `-M' option, above.
  824.  
  825. `--no-keep-memory'
  826.      `ld' normally optimizes for speed over memory usage by caching the
  827.      symbol tables of input files in memory.  This option tells `ld' to
  828.      instead optimize for memory usage, by rereading the symbol tables
  829.      as necessary.  This may be required if `ld' runs out of memory
  830.      space while linking a large executable.
  831.  
  832. `--no-undefined'
  833. `-z defs'
  834.      Report unresolved symbol references from regular object files.
  835.      This is done even if the linker is creating a non-symbolic shared
  836.      library.  The switch `--[no-]allow-shlib-undefined' controls the
  837.      behaviour for reporting unresolved references found in shared
  838.      libraries being linked in.
  839.  
  840. `--allow-multiple-definition'
  841. `-z muldefs'
  842.      Normally when a symbol is defined multiple times, the linker will
  843.      report a fatal error. These options allow multiple definitions and
  844.      the first definition will be used.
  845.  
  846. `--allow-shlib-undefined'
  847. `--no-allow-shlib-undefined'
  848.      Allows (the default) or disallows undefined symbols in shared
  849.      libraries.  This switch is similar to `--no-undefined' except that
  850.      it determines the behaviour when the undefined symbols are in a
  851.      shared library rather than a regular object file.  It does not
  852.      affect how undefined symbols in regular object files are handled.
  853.  
  854.      The reason that `--allow-shlib-undefined' is the default is that
  855.      the shared library being specified at link time may not be the
  856.      same as the one that is available at load time, so the symbols
  857.      might actually be resolvable at load time.  Plus there are some
  858.      systems, (eg BeOS) where undefined symbols in shared libraries is
  859.      normal.  (The kernel patches them at load time to select which
  860.      function is most appropriate for the current architecture.  This
  861.      is used for example to dynamically select an appropriate memset
  862.      function).  Apparently it is also normal for HPPA shared libraries
  863.      to have undefined symbols.
  864.  
  865. `--no-undefined-version'
  866.      Normally when a symbol has an undefined version, the linker will
  867.      ignore it. This option disallows symbols with undefined version
  868.      and a fatal error will be issued instead.
  869.  
  870. `--default-symver'
  871.      Create and use a default symbol version (the soname) for
  872.      unversioned exported symbols.
  873.  
  874. `--default-imported-symver'
  875.      Create and use a default symbol version (the soname) for
  876.      unversioned imported symbols.
  877.  
  878. `--no-warn-mismatch'
  879.      Normally `ld' will give an error if you try to link together input
  880.      files that are mismatched for some reason, perhaps because they
  881.      have been compiled for different processors or for different
  882.      endiannesses.  This option tells `ld' that it should silently
  883.      permit such possible errors.  This option should only be used with
  884.      care, in cases when you have taken some special action that
  885.      ensures that the linker errors are inappropriate.
  886.  
  887. `--no-whole-archive'
  888.      Turn off the effect of the `--whole-archive' option for subsequent
  889.      archive files.
  890.  
  891. `--noinhibit-exec'
  892.      Retain the executable output file whenever it is still usable.
  893.      Normally, the linker will not produce an output file if it
  894.      encounters errors during the link process; it exits without
  895.      writing an output file when it issues any error whatsoever.
  896.  
  897. `-nostdlib'
  898.      Only search library directories explicitly specified on the
  899.      command line.  Library directories specified in linker scripts
  900.      (including linker scripts specified on the command line) are
  901.      ignored.
  902.  
  903. `--oformat OUTPUT-FORMAT'
  904.      `ld' may be configured to support more than one kind of object
  905.      file.  If your `ld' is configured this way, you can use the
  906.      `--oformat' option to specify the binary format for the output
  907.      object file.  Even when `ld' is configured to support alternative
  908.      object formats, you don't usually need to specify this, as `ld'
  909.      should be configured to produce as a default output format the most
  910.      usual format on each machine.  OUTPUT-FORMAT is a text string, the
  911.      name of a particular format supported by the BFD libraries.  (You
  912.      can list the available binary formats with `objdump -i'.)  The
  913.      script command `OUTPUT_FORMAT' can also specify the output format,
  914.      but this option overrides it.  *Note BFD::.
  915.  
  916. `-pie'
  917. `--pic-executable'
  918.      Create a position independent executable.  This is currently only
  919.      supported on ELF platforms.  Position independent executables are
  920.      similar to shared libraries in that they are relocated by the
  921.      dynamic linker to the virtual address the OS chooses for them
  922.      (which can vary between invocations).  Like normal dynamically
  923.      linked executables they can be executed and symbols defined in the
  924.      executable cannot be overridden by shared libraries.
  925.  
  926. `-qmagic'
  927.      This option is ignored for Linux compatibility.
  928.  
  929. `-Qy'
  930.      This option is ignored for SVR4 compatibility.
  931.  
  932. `--relax'
  933.      An option with machine dependent effects.  This option is only
  934.      supported on a few targets.  *Note `ld' and the H8/300: H8/300.
  935.      *Note `ld' and the Intel 960 family: i960.  *Note `ld' and Xtensa
  936.      Processors: Xtensa.
  937.  
  938.      On some platforms, the `--relax' option performs global
  939.      optimizations that become possible when the linker resolves
  940.      addressing in the program, such as relaxing address modes and
  941.      synthesizing new instructions in the output object file.
  942.  
  943.      On some platforms these link time global optimizations may make
  944.      symbolic debugging of the resulting executable impossible.  This
  945.      is known to be the case for the Matsushita MN10200 and MN10300
  946.      family of processors.
  947.  
  948.      On platforms where this is not supported, `--relax' is accepted,
  949.      but ignored.
  950.  
  951. `--retain-symbols-file FILENAME'
  952.      Retain _only_ the symbols listed in the file FILENAME, discarding
  953.      all others.  FILENAME is simply a flat file, with one symbol name
  954.      per line.  This option is especially useful in environments (such
  955.      as VxWorks) where a large global symbol table is accumulated
  956.      gradually, to conserve run-time memory.
  957.  
  958.      `--retain-symbols-file' does _not_ discard undefined symbols, or
  959.      symbols needed for relocations.
  960.  
  961.      You may only specify `--retain-symbols-file' once in the command
  962.      line.  It overrides `-s' and `-S'.
  963.  
  964. `-rpath DIR'
  965.      Add a directory to the runtime library search path.  This is used
  966.      when linking an ELF executable with shared objects.  All `-rpath'
  967.      arguments are concatenated and passed to the runtime linker, which
  968.      uses them to locate shared objects at runtime.  The `-rpath'
  969.      option is also used when locating shared objects which are needed
  970.      by shared objects explicitly included in the link; see the
  971.      description of the `-rpath-link' option.  If `-rpath' is not used
  972.      when linking an ELF executable, the contents of the environment
  973.      variable `LD_RUN_PATH' will be used if it is defined.
  974.  
  975.      The `-rpath' option may also be used on SunOS.  By default, on
  976.      SunOS, the linker will form a runtime search patch out of all the
  977.      `-L' options it is given.  If a `-rpath' option is used, the
  978.      runtime search path will be formed exclusively using the `-rpath'
  979.      options, ignoring the `-L' options.  This can be useful when using
  980.      gcc, which adds many `-L' options which may be on NFS mounted
  981.      filesystems.
  982.  
  983.      For compatibility with other ELF linkers, if the `-R' option is
  984.      followed by a directory name, rather than a file name, it is
  985.      treated as the `-rpath' option.
  986.  
  987. `-rpath-link DIR'
  988.      When using ELF or SunOS, one shared library may require another.
  989.      This happens when an `ld -shared' link includes a shared library
  990.      as one of the input files.
  991.  
  992.      When the linker encounters such a dependency when doing a
  993.      non-shared, non-relocatable link, it will automatically try to
  994.      locate the required shared library and include it in the link, if
  995.      it is not included explicitly.  In such a case, the `-rpath-link'
  996.      option specifies the first set of directories to search.  The
  997.      `-rpath-link' option may specify a sequence of directory names
  998.      either by specifying a list of names separated by colons, or by
  999.      appearing multiple times.
  1000.  
  1001.      This option should be used with caution as it overrides the search
  1002.      path that may have been hard compiled into a shared library. In
  1003.      such a case it is possible to use unintentionally a different
  1004.      search path than the runtime linker would do.
  1005.  
  1006.      The linker uses the following search paths to locate required
  1007.      shared libraries.
  1008.        1. Any directories specified by `-rpath-link' options.
  1009.  
  1010.        2. Any directories specified by `-rpath' options.  The difference
  1011.           between `-rpath' and `-rpath-link' is that directories
  1012.           specified by `-rpath' options are included in the executable
  1013.           and used at runtime, whereas the `-rpath-link' option is only
  1014.           effective at link time. It is for the native linker only.
  1015.  
  1016.        3. On an ELF system, if the `-rpath' and `rpath-link' options
  1017.           were not used, search the contents of the environment variable
  1018.           `LD_RUN_PATH'. It is for the native linker only.
  1019.  
  1020.        4. On SunOS, if the `-rpath' option was not used, search any
  1021.           directories specified using `-L' options.
  1022.  
  1023.        5. For a native linker, the contents of the environment variable
  1024.           `LD_LIBRARY_PATH'.
  1025.  
  1026.        6. For a native ELF linker, the directories in `DT_RUNPATH' or
  1027.           `DT_RPATH' of a shared library are searched for shared
  1028.           libraries needed by it. The `DT_RPATH' entries are ignored if
  1029.           `DT_RUNPATH' entries exist.
  1030.  
  1031.        7. The default directories, normally `/lib' and `/usr/lib'.
  1032.  
  1033.        8. For a native linker on an ELF system, if the file
  1034.           `/etc/ld.so.conf' exists, the list of directories found in
  1035.           that file.
  1036.  
  1037.      If the required shared library is not found, the linker will issue
  1038.      a warning and continue with the link.
  1039.  
  1040. `-shared'
  1041. `-Bshareable'
  1042.      Create a shared library.  This is currently only supported on ELF,
  1043.      XCOFF and SunOS platforms.  On SunOS, the linker will
  1044.      automatically create a shared library if the `-e' option is not
  1045.      used and there are undefined symbols in the link.
  1046.  
  1047. `--sort-common'
  1048.      This option tells `ld' to sort the common symbols by size when it
  1049.      places them in the appropriate output sections.  First come all
  1050.      the one byte symbols, then all the two byte, then all the four
  1051.      byte, and then everything else.  This is to prevent gaps between
  1052.      symbols due to alignment constraints.
  1053.  
  1054. `--sort-section name'
  1055.      This option will apply `SORT_BY_NAME' to all wildcard section
  1056.      patterns in the linker script.
  1057.  
  1058. `--sort-section alignment'
  1059.      This option will apply `SORT_BY_ALIGNMENT' to all wildcard section
  1060.      patterns in the linker script.
  1061.  
  1062. `--split-by-file [SIZE]'
  1063.      Similar to `--split-by-reloc' but creates a new output section for
  1064.      each input file when SIZE is reached.  SIZE defaults to a size of
  1065.      1 if not given.
  1066.  
  1067. `--split-by-reloc [COUNT]'
  1068.      Tries to creates extra sections in the output file so that no
  1069.      single output section in the file contains more than COUNT
  1070.      relocations.  This is useful when generating huge relocatable
  1071.      files for downloading into certain real time kernels with the COFF
  1072.      object file format; since COFF cannot represent more than 65535
  1073.      relocations in a single section.  Note that this will fail to work
  1074.      with object file formats which do not support arbitrary sections.
  1075.      The linker will not split up individual input sections for
  1076.      redistribution, so if a single input section contains more than
  1077.      COUNT relocations one output section will contain that many
  1078.      relocations.  COUNT defaults to a value of 32768.
  1079.  
  1080. `--stats'
  1081.      Compute and display statistics about the operation of the linker,
  1082.      such as execution time and memory usage.
  1083.  
  1084. `--sysroot=DIRECTORY'
  1085.      Use DIRECTORY as the location of the sysroot, overriding the
  1086.      configure-time default.  This option is only supported by linkers
  1087.      that were configured using `--with-sysroot'.
  1088.  
  1089. `--traditional-format'
  1090.      For some targets, the output of `ld' is different in some ways from
  1091.      the output of some existing linker.  This switch requests `ld' to
  1092.      use the traditional format instead.
  1093.  
  1094.      For example, on SunOS, `ld' combines duplicate entries in the
  1095.      symbol string table.  This can reduce the size of an output file
  1096.      with full debugging information by over 30 percent.
  1097.      Unfortunately, the SunOS `dbx' program can not read the resulting
  1098.      program (`gdb' has no trouble).  The `--traditional-format' switch
  1099.      tells `ld' to not combine duplicate entries.
  1100.  
  1101. `--section-start SECTIONNAME=ORG'
  1102.      Locate a section in the output file at the absolute address given
  1103.      by ORG.  You may use this option as many times as necessary to
  1104.      locate multiple sections in the command line.  ORG must be a
  1105.      single hexadecimal integer; for compatibility with other linkers,
  1106.      you may omit the leading `0x' usually associated with hexadecimal
  1107.      values.  _Note:_ there should be no white space between
  1108.      SECTIONNAME, the equals sign ("<=>"), and ORG.
  1109.  
  1110. `-Tbss ORG'
  1111. `-Tdata ORG'
  1112. `-Ttext ORG'
  1113.      Same as -section-start, with `.bss', `.data' or `.text' as the
  1114.      SECTIONNAME.
  1115.  
  1116. `--unresolved-symbols=METHOD'
  1117.      Determine how to handle unresolved symbols.  There are four
  1118.      possible values for `method':
  1119.  
  1120.     `ignore-all'
  1121.           Do not report any unresolved symbols.
  1122.  
  1123.     `report-all'
  1124.           Report all unresolved symbols.  This is the default.
  1125.  
  1126.     `ignore-in-object-files'
  1127.           Report unresolved symbols that are contained in shared
  1128.           libraries, but ignore them if they come from regular object
  1129.           files.
  1130.  
  1131.     `ignore-in-shared-libs'
  1132.           Report unresolved symbols that come from regular object
  1133.           files, but ignore them if they come from shared libraries.
  1134.           This can be useful when creating a dynamic binary and it is
  1135.           known that all the shared libraries that it should be
  1136.           referencing are included on the linker's command line.
  1137.  
  1138.      The behaviour for shared libraries on their own can also be
  1139.      controlled by the `--[no-]allow-shlib-undefined' option.
  1140.  
  1141.      Normally the linker will generate an error message for each
  1142.      reported unresolved symbol but the option
  1143.      `--warn-unresolved-symbols' can change this to a warning.
  1144.  
  1145. `--dll-verbose'
  1146. `--verbose'
  1147.      Display the version number for `ld' and list the linker emulations
  1148.      supported.  Display which input files can and cannot be opened.
  1149.      Display the linker script being used by the linker.
  1150.  
  1151. `--version-script=VERSION-SCRIPTFILE'
  1152.      Specify the name of a version script to the linker.  This is
  1153.      typically used when creating shared libraries to specify
  1154.      additional information about the version hierarchy for the library
  1155.      being created.  This option is only meaningful on ELF platforms
  1156.      which support shared libraries.  *Note VERSION::.
  1157.  
  1158. `--warn-common'
  1159.      Warn when a common symbol is combined with another common symbol
  1160.      or with a symbol definition.  Unix linkers allow this somewhat
  1161.      sloppy practise, but linkers on some other operating systems do
  1162.      not.  This option allows you to find potential problems from
  1163.      combining global symbols.  Unfortunately, some C libraries use
  1164.      this practise, so you may get some warnings about symbols in the
  1165.      libraries as well as in your programs.
  1166.  
  1167.      There are three kinds of global symbols, illustrated here by C
  1168.      examples:
  1169.  
  1170.     `int i = 1;'
  1171.           A definition, which goes in the initialized data section of
  1172.           the output file.
  1173.  
  1174.     `extern int i;'
  1175.           An undefined reference, which does not allocate space.  There
  1176.           must be either a definition or a common symbol for the
  1177.           variable somewhere.
  1178.  
  1179.     `int i;'
  1180.           A common symbol.  If there are only (one or more) common
  1181.           symbols for a variable, it goes in the uninitialized data
  1182.           area of the output file.  The linker merges multiple common
  1183.           symbols for the same variable into a single symbol.  If they
  1184.           are of different sizes, it picks the largest size.  The
  1185.           linker turns a common symbol into a declaration, if there is
  1186.           a definition of the same variable.
  1187.  
  1188.      The `--warn-common' option can produce five kinds of warnings.
  1189.      Each warning consists of a pair of lines: the first describes the
  1190.      symbol just encountered, and the second describes the previous
  1191.      symbol encountered with the same name.  One or both of the two
  1192.      symbols will be a common symbol.
  1193.  
  1194.        1. Turning a common symbol into a reference, because there is
  1195.           already a definition for the symbol.
  1196.                FILE(SECTION): warning: common of `SYMBOL'
  1197.                   overridden by definition
  1198.                FILE(SECTION): warning: defined here
  1199.  
  1200.        2. Turning a common symbol into a reference, because a later
  1201.           definition for the symbol is encountered.  This is the same
  1202.           as the previous case, except that the symbols are encountered
  1203.           in a different order.
  1204.                FILE(SECTION): warning: definition of `SYMBOL'
  1205.                   overriding common
  1206.                FILE(SECTION): warning: common is here
  1207.  
  1208.        3. Merging a common symbol with a previous same-sized common
  1209.           symbol.
  1210.                FILE(SECTION): warning: multiple common
  1211.                   of `SYMBOL'
  1212.                FILE(SECTION): warning: previous common is here
  1213.  
  1214.        4. Merging a common symbol with a previous larger common symbol.
  1215.                FILE(SECTION): warning: common of `SYMBOL'
  1216.                   overridden by larger common
  1217.                FILE(SECTION): warning: larger common is here
  1218.  
  1219.        5. Merging a common symbol with a previous smaller common
  1220.           symbol.  This is the same as the previous case, except that
  1221.           the symbols are encountered in a different order.
  1222.                FILE(SECTION): warning: common of `SYMBOL'
  1223.                   overriding smaller common
  1224.                FILE(SECTION): warning: smaller common is here
  1225.  
  1226. `--warn-constructors'
  1227.      Warn if any global constructors are used.  This is only useful for
  1228.      a few object file formats.  For formats like COFF or ELF, the
  1229.      linker can not detect the use of global constructors.
  1230.  
  1231. `--warn-multiple-gp'
  1232.      Warn if multiple global pointer values are required in the output
  1233.      file.  This is only meaningful for certain processors, such as the
  1234.      Alpha.  Specifically, some processors put large-valued constants
  1235.      in a special section.  A special register (the global pointer)
  1236.      points into the middle of this section, so that constants can be
  1237.      loaded efficiently via a base-register relative addressing mode.
  1238.      Since the offset in base-register relative mode is fixed and
  1239.      relatively small (e.g., 16 bits), this limits the maximum size of
  1240.      the constant pool.  Thus, in large programs, it is often necessary
  1241.      to use multiple global pointer values in order to be able to
  1242.      address all possible constants.  This option causes a warning to
  1243.      be issued whenever this case occurs.
  1244.  
  1245. `--warn-once'
  1246.      Only warn once for each undefined symbol, rather than once per
  1247.      module which refers to it.
  1248.  
  1249. `--warn-section-align'
  1250.      Warn if the address of an output section is changed because of
  1251.      alignment.  Typically, the alignment will be set by an input
  1252.      section.  The address will only be changed if it not explicitly
  1253.      specified; that is, if the `SECTIONS' command does not specify a
  1254.      start address for the section (*note SECTIONS::).
  1255.  
  1256. `--warn-shared-textrel'
  1257.      Warn if the linker adds a DT_TEXTREL to a shared object.
  1258.  
  1259. `--warn-unresolved-symbols'
  1260.      If the linker is going to report an unresolved symbol (see the
  1261.      option `--unresolved-symbols') it will normally generate an error.
  1262.      This option makes it generate a warning instead.
  1263.  
  1264. `--error-unresolved-symbols'
  1265.      This restores the linker's default behaviour of generating errors
  1266.      when it is reporting unresolved symbols.
  1267.  
  1268. `--whole-archive'
  1269.      For each archive mentioned on the command line after the
  1270.      `--whole-archive' option, include every object file in the archive
  1271.      in the link, rather than searching the archive for the required
  1272.      object files.  This is normally used to turn an archive file into
  1273.      a shared library, forcing every object to be included in the
  1274.      resulting shared library.  This option may be used more than once.
  1275.  
  1276.      Two notes when using this option from gcc: First, gcc doesn't know
  1277.      about this option, so you have to use `-Wl,-whole-archive'.
  1278.      Second, don't forget to use `-Wl,-no-whole-archive' after your
  1279.      list of archives, because gcc will add its own list of archives to
  1280.      your link and you may not want this flag to affect those as well.
  1281.  
  1282. `--wrap SYMBOL'
  1283.      Use a wrapper function for SYMBOL.  Any undefined reference to
  1284.      SYMBOL will be resolved to `__wrap_SYMBOL'.  Any undefined
  1285.      reference to `__real_SYMBOL' will be resolved to SYMBOL.
  1286.  
  1287.      This can be used to provide a wrapper for a system function.  The
  1288.      wrapper function should be called `__wrap_SYMBOL'.  If it wishes
  1289.      to call the system function, it should call `__real_SYMBOL'.
  1290.  
  1291.      Here is a trivial example:
  1292.  
  1293.           void *
  1294.           __wrap_malloc (size_t c)
  1295.           {
  1296.             printf ("malloc called with %zu\n", c);
  1297.             return __real_malloc (c);
  1298.           }
  1299.  
  1300.      If you link other code with this file using `--wrap malloc', then
  1301.      all calls to `malloc' will call the function `__wrap_malloc'
  1302.      instead.  The call to `__real_malloc' in `__wrap_malloc' will call
  1303.      the real `malloc' function.
  1304.  
  1305.      You may wish to provide a `__real_malloc' function as well, so that
  1306.      links without the `--wrap' option will succeed.  If you do this,
  1307.      you should not put the definition of `__real_malloc' in the same
  1308.      file as `__wrap_malloc'; if you do, the assembler may resolve the
  1309.      call before the linker has a chance to wrap it to `malloc'.
  1310.  
  1311. `--enable-new-dtags'
  1312. `--disable-new-dtags'
  1313.      This linker can create the new dynamic tags in ELF. But the older
  1314.      ELF systems may not understand them. If you specify
  1315.      `--enable-new-dtags', the dynamic tags will be created as needed.
  1316.      If you specify `--disable-new-dtags', no new dynamic tags will be
  1317.      created. By default, the new dynamic tags are not created. Note
  1318.      that those options are only available for ELF systems.
  1319.  
  1320. `--hash-size=NUMBER'
  1321.      Set the default size of the linker's hash tables to a prime number
  1322.      close to NUMBER.  Increasing this value can reduce the length of
  1323.      time it takes the linker to perform its tasks, at the expense of
  1324.      increasing the linker's memory requirements.  Similarly reducing
  1325.      this value can reduce the memory requirements at the expense of
  1326.      speed.
  1327.  
  1328. `--reduce-memory-overheads'
  1329.      This option reduces memory requirements at ld runtime, at the
  1330.      expense of linking speed.  This was introduced to to select the
  1331.      old O(n^2) algorithm for link map file generation, rather than the
  1332.      new O(n) algorithm which uses about 40% more memory for symbol
  1333.      storage.
  1334.  
  1335.      Another affect of the switch is to set the default hash table size
  1336.      to 1021, which again saves memory at the cost of lengthening the
  1337.      linker's run time.  This is not done however if the `--hash-size'
  1338.      switch has been used.
  1339.  
  1340.      The `--reduce-memory-overheads' switch may be also be used to
  1341.      enable other tradeoffs in future versions of the linker.
  1342.  
  1343.  
  1344. 2.1.1 Options Specific to i386 PE Targets
  1345. -----------------------------------------
  1346.  
  1347. The i386 PE linker supports the `-shared' option, which causes the
  1348. output to be a dynamically linked library (DLL) instead of a normal
  1349. executable.  You should name the output `*.dll' when you use this
  1350. option.  In addition, the linker fully supports the standard `*.def'
  1351. files, which may be specified on the linker command line like an object
  1352. file (in fact, it should precede archives it exports symbols from, to
  1353. ensure that they get linked in, just like a normal object file).
  1354.  
  1355.    In addition to the options common to all targets, the i386 PE linker
  1356. support additional command line options that are specific to the i386
  1357. PE target.  Options that take values may be separated from their values
  1358. by either a space or an equals sign.
  1359.  
  1360. `--add-stdcall-alias'
  1361.      If given, symbols with a stdcall suffix (@NN) will be exported
  1362.      as-is and also with the suffix stripped.  [This option is specific
  1363.      to the i386 PE targeted port of the linker]
  1364.  
  1365. `--base-file FILE'
  1366.      Use FILE as the name of a file in which to save the base addresses
  1367.      of all the relocations needed for generating DLLs with `dlltool'.
  1368.      [This is an i386 PE specific option]
  1369.  
  1370. `--dll'
  1371.      Create a DLL instead of a regular executable.  You may also use
  1372.      `-shared' or specify a `LIBRARY' in a given `.def' file.  [This
  1373.      option is specific to the i386 PE targeted port of the linker]
  1374.  
  1375. `--enable-stdcall-fixup'
  1376. `--disable-stdcall-fixup'
  1377.      If the link finds a symbol that it cannot resolve, it will attempt
  1378.      to do "fuzzy linking" by looking for another defined symbol that
  1379.      differs only in the format of the symbol name (cdecl vs stdcall)
  1380.      and will resolve that symbol by linking to the match.  For
  1381.      example, the undefined symbol `_foo' might be linked to the
  1382.      function `_foo@12', or the undefined symbol `_bar@16' might be
  1383.      linked to the function `_bar'.  When the linker does this, it
  1384.      prints a warning, since it normally should have failed to link,
  1385.      but sometimes import libraries generated from third-party dlls may
  1386.      need this feature to be usable.  If you specify
  1387.      `--enable-stdcall-fixup', this feature is fully enabled and
  1388.      warnings are not printed.  If you specify
  1389.      `--disable-stdcall-fixup', this feature is disabled and such
  1390.      mismatches are considered to be errors.  [This option is specific
  1391.      to the i386 PE targeted port of the linker]
  1392.  
  1393. `--export-all-symbols'
  1394.      If given, all global symbols in the objects used to build a DLL
  1395.      will be exported by the DLL.  Note that this is the default if
  1396.      there otherwise wouldn't be any exported symbols.  When symbols are
  1397.      explicitly exported via DEF files or implicitly exported via
  1398.      function attributes, the default is to not export anything else
  1399.      unless this option is given.  Note that the symbols `DllMain@12',
  1400.      `DllEntryPoint@0', `DllMainCRTStartup@12', and `impure_ptr' will
  1401.      not be automatically exported.  Also, symbols imported from other
  1402.      DLLs will not be re-exported, nor will symbols specifying the
  1403.      DLL's internal layout such as those beginning with `_head_' or
  1404.      ending with `_iname'.  In addition, no symbols from `libgcc',
  1405.      `libstd++', `libmingw32', or `crtX.o' will be exported.  Symbols
  1406.      whose names begin with `__rtti_' or `__builtin_' will not be
  1407.      exported, to help with C++ DLLs.  Finally, there is an extensive
  1408.      list of cygwin-private symbols that are not exported (obviously,
  1409.      this applies on when building DLLs for cygwin targets).  These
  1410.      cygwin-excludes are: `_cygwin_dll_entry@12',
  1411.      `_cygwin_crt0_common@8', `_cygwin_noncygwin_dll_entry@12',
  1412.      `_fmode', `_impure_ptr', `cygwin_attach_dll', `cygwin_premain0',
  1413.      `cygwin_premain1', `cygwin_premain2', `cygwin_premain3', and
  1414.      `environ'.  [This option is specific to the i386 PE targeted port
  1415.      of the linker]
  1416.  
  1417. `--exclude-symbols SYMBOL,SYMBOL,...'
  1418.      Specifies a list of symbols which should not be automatically
  1419.      exported.  The symbol names may be delimited by commas or colons.
  1420.      [This option is specific to the i386 PE targeted port of the
  1421.      linker]
  1422.  
  1423. `--file-alignment'
  1424.      Specify the file alignment.  Sections in the file will always
  1425.      begin at file offsets which are multiples of this number.  This
  1426.      defaults to 512.  [This option is specific to the i386 PE targeted
  1427.      port of the linker]
  1428.  
  1429. `--heap RESERVE'
  1430. `--heap RESERVE,COMMIT'
  1431.      Specify the amount of memory to reserve (and optionally commit) to
  1432.      be used as heap for this program.  The default is 1Mb reserved, 4K
  1433.      committed.  [This option is specific to the i386 PE targeted port
  1434.      of the linker]
  1435.  
  1436. `--image-base VALUE'
  1437.      Use VALUE as the base address of your program or dll.  This is the
  1438.      lowest memory location that will be used when your program or dll
  1439.      is loaded.  To reduce the need to relocate and improve performance
  1440.      of your dlls, each should have a unique base address and not
  1441.      overlap any other dlls.  The default is 0x400000 for executables,
  1442.      and 0x10000000 for dlls.  [This option is specific to the i386 PE
  1443.      targeted port of the linker]
  1444.  
  1445. `--kill-at'
  1446.      If given, the stdcall suffixes (@NN) will be stripped from symbols
  1447.      before they are exported.  [This option is specific to the i386 PE
  1448.      targeted port of the linker]
  1449.  
  1450. `--large-address-aware'
  1451.      If given, the appropriate bit in the "Charateristics" field of the
  1452.      COFF header is set to indicate that this executable supports
  1453.      virtual addresses greater than 2 gigabytes.  This should be used
  1454.      in conjuction with the /3GB or /USERVA=VALUE megabytes switch in
  1455.      the "[operating systems]" section of the BOOT.INI.  Otherwise,
  1456.      this bit has no effect.  [This option is specific to PE targeted
  1457.      ports of the linker]
  1458.  
  1459. `--major-image-version VALUE'
  1460.      Sets the major number of the "image version".  Defaults to 1.
  1461.      [This option is specific to the i386 PE targeted port of the
  1462.      linker]
  1463.  
  1464. `--major-os-version VALUE'
  1465.      Sets the major number of the "os version".  Defaults to 4.  [This
  1466.      option is specific to the i386 PE targeted port of the linker]
  1467.  
  1468. `--major-subsystem-version VALUE'
  1469.      Sets the major number of the "subsystem version".  Defaults to 4.
  1470.      [This option is specific to the i386 PE targeted port of the
  1471.      linker]
  1472.  
  1473. `--minor-image-version VALUE'
  1474.      Sets the minor number of the "image version".  Defaults to 0.
  1475.      [This option is specific to the i386 PE targeted port of the
  1476.      linker]
  1477.  
  1478. `--minor-os-version VALUE'
  1479.      Sets the minor number of the "os version".  Defaults to 0.  [This
  1480.      option is specific to the i386 PE targeted port of the linker]
  1481.  
  1482. `--minor-subsystem-version VALUE'
  1483.      Sets the minor number of the "subsystem version".  Defaults to 0.
  1484.      [This option is specific to the i386 PE targeted port of the
  1485.      linker]
  1486.  
  1487. `--output-def FILE'
  1488.      The linker will create the file FILE which will contain a DEF file
  1489.      corresponding to the DLL the linker is generating.  This DEF file
  1490.      (which should be called `*.def') may be used to create an import
  1491.      library with `dlltool' or may be used as a reference to
  1492.      automatically or implicitly exported symbols.  [This option is
  1493.      specific to the i386 PE targeted port of the linker]
  1494.  
  1495. `--out-implib FILE'
  1496.      The linker will create the file FILE which will contain an import
  1497.      lib corresponding to the DLL the linker is generating. This import
  1498.      lib (which should be called `*.dll.a' or `*.a' may be used to link
  1499.      clients against the generated DLL; this behaviour makes it
  1500.      possible to skip a separate `dlltool' import library creation step.
  1501.      [This option is specific to the i386 PE targeted port of the
  1502.      linker]
  1503.  
  1504. `--enable-auto-image-base'
  1505.      Automatically choose the image base for DLLs, unless one is
  1506.      specified using the `--image-base' argument.  By using a hash
  1507.      generated from the dllname to create unique image bases for each
  1508.      DLL, in-memory collisions and relocations which can delay program
  1509.      execution are avoided.  [This option is specific to the i386 PE
  1510.      targeted port of the linker]
  1511.  
  1512. `--disable-auto-image-base'
  1513.      Do not automatically generate a unique image base.  If there is no
  1514.      user-specified image base (`--image-base') then use the platform
  1515.      default.  [This option is specific to the i386 PE targeted port of
  1516.      the linker]
  1517.  
  1518. `--dll-search-prefix STRING'
  1519.      When linking dynamically to a dll without an import library,
  1520.      search for `<string><basename>.dll' in preference to
  1521.      `lib<basename>.dll'. This behaviour allows easy distinction
  1522.      between DLLs built for the various "subplatforms": native, cygwin,
  1523.      uwin, pw, etc.  For instance, cygwin DLLs typically use
  1524.      `--dll-search-prefix=cyg'.  [This option is specific to the i386
  1525.      PE targeted port of the linker]
  1526.  
  1527. `--enable-auto-import'
  1528.      Do sophisticated linking of `_symbol' to `__imp__symbol' for DATA
  1529.      imports from DLLs, and create the necessary thunking symbols when
  1530.      building the import libraries with those DATA exports. Note: Use
  1531.      of the 'auto-import' extension will cause the text section of the
  1532.      image file to be made writable. This does not conform to the
  1533.      PE-COFF format specification published by Microsoft.
  1534.  
  1535.      Using 'auto-import' generally will 'just work' - but sometimes you
  1536.      may see this message:
  1537.  
  1538.      "variable '<var>' can't be auto-imported. Please read the
  1539.      documentation for ld's `--enable-auto-import' for details."
  1540.  
  1541.      This message occurs when some (sub)expression accesses an address
  1542.      ultimately given by the sum of two constants (Win32 import tables
  1543.      only allow one).  Instances where this may occur include accesses
  1544.      to member fields of struct variables imported from a DLL, as well
  1545.      as using a constant index into an array variable imported from a
  1546.      DLL.  Any multiword variable (arrays, structs, long long, etc) may
  1547.      trigger this error condition.  However, regardless of the exact
  1548.      data type of the offending exported variable, ld will always
  1549.      detect it, issue the warning, and exit.
  1550.  
  1551.      There are several ways to address this difficulty, regardless of
  1552.      the data type of the exported variable:
  1553.  
  1554.      One way is to use -enable-runtime-pseudo-reloc switch. This leaves
  1555.      the task of adjusting references in your client code for runtime
  1556.      environment, so this method works only when runtime environment
  1557.      supports this feature.
  1558.  
  1559.      A second solution is to force one of the 'constants' to be a
  1560.      variable - that is, unknown and un-optimizable at compile time.
  1561.      For arrays, there are two possibilities: a) make the indexee (the
  1562.      array's address) a variable, or b) make the 'constant' index a
  1563.      variable.  Thus:
  1564.  
  1565.           extern type extern_array[];
  1566.           extern_array[1] -->
  1567.              { volatile type *t=extern_array; t[1] }
  1568.  
  1569.      or
  1570.  
  1571.           extern type extern_array[];
  1572.           extern_array[1] -->
  1573.              { volatile int t=1; extern_array[t] }
  1574.  
  1575.      For structs (and most other multiword data types) the only option
  1576.      is to make the struct itself (or the long long, or the ...)
  1577.      variable:
  1578.  
  1579.           extern struct s extern_struct;
  1580.           extern_struct.field -->
  1581.              { volatile struct s *t=&extern_struct; t->field }
  1582.  
  1583.      or
  1584.  
  1585.           extern long long extern_ll;
  1586.           extern_ll -->
  1587.             { volatile long long * local_ll=&extern_ll; *local_ll }
  1588.  
  1589.      A third method of dealing with this difficulty is to abandon
  1590.      'auto-import' for the offending symbol and mark it with
  1591.      `__declspec(dllimport)'.  However, in practise that requires using
  1592.      compile-time #defines to indicate whether you are building a DLL,
  1593.      building client code that will link to the DLL, or merely
  1594.      building/linking to a static library.   In making the choice
  1595.      between the various methods of resolving the 'direct address with
  1596.      constant offset' problem, you should consider typical real-world
  1597.      usage:
  1598.  
  1599.      Original:
  1600.           --foo.h
  1601.           extern int arr[];
  1602.           --foo.c
  1603.           #include "foo.h"
  1604.           void main(int argc, char **argv){
  1605.             printf("%d\n",arr[1]);
  1606.           }
  1607.  
  1608.      Solution 1:
  1609.           --foo.h
  1610.           extern int arr[];
  1611.           --foo.c
  1612.           #include "foo.h"
  1613.           void main(int argc, char **argv){
  1614.             /* This workaround is for win32 and cygwin; do not "optimize" */
  1615.             volatile int *parr = arr;
  1616.             printf("%d\n",parr[1]);
  1617.           }
  1618.  
  1619.      Solution 2:
  1620.           --foo.h
  1621.           /* Note: auto-export is assumed (no __declspec(dllexport)) */
  1622.           #if (defined(_WIN32) || defined(__CYGWIN__)) && \
  1623.             !(defined(FOO_BUILD_DLL) || defined(FOO_STATIC))
  1624.           #define FOO_IMPORT __declspec(dllimport)
  1625.           #else
  1626.           #define FOO_IMPORT
  1627.           #endif
  1628.           extern FOO_IMPORT int arr[];
  1629.           --foo.c
  1630.           #include "foo.h"
  1631.           void main(int argc, char **argv){
  1632.             printf("%d\n",arr[1]);
  1633.           }
  1634.  
  1635.      A fourth way to avoid this problem is to re-code your library to
  1636.      use a functional interface rather than a data interface for the
  1637.      offending variables (e.g. set_foo() and get_foo() accessor
  1638.      functions).  [This option is specific to the i386 PE targeted port
  1639.      of the linker]
  1640.  
  1641. `--disable-auto-import'
  1642.      Do not attempt to do sophisticated linking of `_symbol' to
  1643.      `__imp__symbol' for DATA imports from DLLs.  [This option is
  1644.      specific to the i386 PE targeted port of the linker]
  1645.  
  1646. `--enable-runtime-pseudo-reloc'
  1647.      If your code contains expressions described in -enable-auto-import
  1648.      section, that is, DATA imports from DLL with non-zero offset, this
  1649.      switch will create a vector of 'runtime pseudo relocations' which
  1650.      can be used by runtime environment to adjust references to such
  1651.      data in your client code.  [This option is specific to the i386 PE
  1652.      targeted port of the linker]
  1653.  
  1654. `--disable-runtime-pseudo-reloc'
  1655.      Do not create pseudo relocations for non-zero offset DATA imports
  1656.      from DLLs.  This is the default.  [This option is specific to the
  1657.      i386 PE targeted port of the linker]
  1658.  
  1659. `--enable-extra-pe-debug'
  1660.      Show additional debug info related to auto-import symbol thunking.
  1661.      [This option is specific to the i386 PE targeted port of the
  1662.      linker]
  1663.  
  1664. `--section-alignment'
  1665.      Sets the section alignment.  Sections in memory will always begin
  1666.      at addresses which are a multiple of this number.  Defaults to
  1667.      0x1000.  [This option is specific to the i386 PE targeted port of
  1668.      the linker]
  1669.  
  1670. `--stack RESERVE'
  1671. `--stack RESERVE,COMMIT'
  1672.      Specify the amount of memory to reserve (and optionally commit) to
  1673.      be used as stack for this program.  The default is 2Mb reserved, 4K
  1674.      committed.  [This option is specific to the i386 PE targeted port
  1675.      of the linker]
  1676.  
  1677. `--subsystem WHICH'
  1678. `--subsystem WHICH:MAJOR'
  1679. `--subsystem WHICH:MAJOR.MINOR'
  1680.      Specifies the subsystem under which your program will execute.  The
  1681.      legal values for WHICH are `native', `windows', `console',
  1682.      `posix', and `xbox'.  You may optionally set the subsystem version
  1683.      also.  Numeric values are also accepted for WHICH.  [This option
  1684.      is specific to the i386 PE targeted port of the linker]
  1685.  
  1686.  
  1687. 
  1688. File: ld.info,  Node: Environment,  Prev: Options,  Up: Invocation
  1689.  
  1690. 2.2 Environment Variables
  1691. =========================
  1692.  
  1693. You can change the behaviour of `ld' with the environment variables
  1694. `GNUTARGET', `LDEMULATION' and `COLLECT_NO_DEMANGLE'.
  1695.  
  1696.    `GNUTARGET' determines the input-file object format if you don't use
  1697. `-b' (or its synonym `--format').  Its value should be one of the BFD
  1698. names for an input format (*note BFD::).  If there is no `GNUTARGET' in
  1699. the environment, `ld' uses the natural format of the target. If
  1700. `GNUTARGET' is set to `default' then BFD attempts to discover the input
  1701. format by examining binary input files; this method often succeeds, but
  1702. there are potential ambiguities, since there is no method of ensuring
  1703. that the magic number used to specify object-file formats is unique.
  1704. However, the configuration procedure for BFD on each system places the
  1705. conventional format for that system first in the search-list, so
  1706. ambiguities are resolved in favor of convention.
  1707.  
  1708.    `LDEMULATION' determines the default emulation if you don't use the
  1709. `-m' option.  The emulation can affect various aspects of linker
  1710. behaviour, particularly the default linker script.  You can list the
  1711. available emulations with the `--verbose' or `-V' options.  If the `-m'
  1712. option is not used, and the `LDEMULATION' environment variable is not
  1713. defined, the default emulation depends upon how the linker was
  1714. configured.
  1715.  
  1716.    Normally, the linker will default to demangling symbols.  However, if
  1717. `COLLECT_NO_DEMANGLE' is set in the environment, then it will default
  1718. to not demangling symbols.  This environment variable is used in a
  1719. similar fashion by the `gcc' linker wrapper program.  The default may
  1720. be overridden by the `--demangle' and `--no-demangle' options.
  1721.  
  1722. 
  1723. File: ld.info,  Node: Scripts,  Next: Machine Dependent,  Prev: Invocation,  Up: Top
  1724.  
  1725. 3 Linker Scripts
  1726. ****************
  1727.  
  1728. Every link is controlled by a "linker script".  This script is written
  1729. in the linker command language.
  1730.  
  1731.    The main purpose of the linker script is to describe how the
  1732. sections in the input files should be mapped into the output file, and
  1733. to control the memory layout of the output file.  Most linker scripts
  1734. do nothing more than this.  However, when necessary, the linker script
  1735. can also direct the linker to perform many other operations, using the
  1736. commands described below.
  1737.  
  1738.    The linker always uses a linker script.  If you do not supply one
  1739. yourself, the linker will use a default script that is compiled into the
  1740. linker executable.  You can use the `--verbose' command line option to
  1741. display the default linker script.  Certain command line options, such
  1742. as `-r' or `-N', will affect the default linker script.
  1743.  
  1744.    You may supply your own linker script by using the `-T' command line
  1745. option.  When you do this, your linker script will replace the default
  1746. linker script.
  1747.  
  1748.    You may also use linker scripts implicitly by naming them as input
  1749. files to the linker, as though they were files to be linked.  *Note
  1750. Implicit Linker Scripts::.
  1751.  
  1752. * Menu:
  1753.  
  1754. * Basic Script Concepts::    Basic Linker Script Concepts
  1755. * Script Format::        Linker Script Format
  1756. * Simple Example::        Simple Linker Script Example
  1757. * Simple Commands::        Simple Linker Script Commands
  1758. * Assignments::            Assigning Values to Symbols
  1759. * SECTIONS::            SECTIONS Command
  1760. * MEMORY::            MEMORY Command
  1761. * PHDRS::            PHDRS Command
  1762. * VERSION::            VERSION Command
  1763. * Expressions::            Expressions in Linker Scripts
  1764. * Implicit Linker Scripts::    Implicit Linker Scripts
  1765.  
  1766. 
  1767. File: ld.info,  Node: Basic Script Concepts,  Next: Script Format,  Up: Scripts
  1768.  
  1769. 3.1 Basic Linker Script Concepts
  1770. ================================
  1771.  
  1772. We need to define some basic concepts and vocabulary in order to
  1773. describe the linker script language.
  1774.  
  1775.    The linker combines input files into a single output file.  The
  1776. output file and each input file are in a special data format known as an
  1777. "object file format".  Each file is called an "object file".  The
  1778. output file is often called an "executable", but for our purposes we
  1779. will also call it an object file.  Each object file has, among other
  1780. things, a list of "sections".  We sometimes refer to a section in an
  1781. input file as an "input section"; similarly, a section in the output
  1782. file is an "output section".
  1783.  
  1784.    Each section in an object file has a name and a size.  Most sections
  1785. also have an associated block of data, known as the "section contents".
  1786. A section may be marked as "loadable", which mean that the contents
  1787. should be loaded into memory when the output file is run.  A section
  1788. with no contents may be "allocatable", which means that an area in
  1789. memory should be set aside, but nothing in particular should be loaded
  1790. there (in some cases this memory must be zeroed out).  A section which
  1791. is neither loadable nor allocatable typically contains some sort of
  1792. debugging information.
  1793.  
  1794.    Every loadable or allocatable output section has two addresses.  The
  1795. first is the "VMA", or virtual memory address.  This is the address the
  1796. section will have when the output file is run.  The second is the
  1797. "LMA", or load memory address.  This is the address at which the
  1798. section will be loaded.  In most cases the two addresses will be the
  1799. same.  An example of when they might be different is when a data section
  1800. is loaded into ROM, and then copied into RAM when the program starts up
  1801. (this technique is often used to initialize global variables in a ROM
  1802. based system).  In this case the ROM address would be the LMA, and the
  1803. RAM address would be the VMA.
  1804.  
  1805.    You can see the sections in an object file by using the `objdump'
  1806. program with the `-h' option.
  1807.  
  1808.    Every object file also has a list of "symbols", known as the "symbol
  1809. table".  A symbol may be defined or undefined.  Each symbol has a name,
  1810. and each defined symbol has an address, among other information.  If
  1811. you compile a C or C++ program into an object file, you will get a
  1812. defined symbol for every defined function and global or static
  1813. variable.  Every undefined function or global variable which is
  1814. referenced in the input file will become an undefined symbol.
  1815.  
  1816.    You can see the symbols in an object file by using the `nm' program,
  1817. or by using the `objdump' program with the `-t' option.
  1818.  
  1819. 
  1820. File: ld.info,  Node: Script Format,  Next: Simple Example,  Prev: Basic Script Concepts,  Up: Scripts
  1821.  
  1822. 3.2 Linker Script Format
  1823. ========================
  1824.  
  1825. Linker scripts are text files.
  1826.  
  1827.    You write a linker script as a series of commands.  Each command is
  1828. either a keyword, possibly followed by arguments, or an assignment to a
  1829. symbol.  You may separate commands using semicolons.  Whitespace is
  1830. generally ignored.
  1831.  
  1832.    Strings such as file or format names can normally be entered
  1833. directly.  If the file name contains a character such as a comma which
  1834. would otherwise serve to separate file names, you may put the file name
  1835. in double quotes.  There is no way to use a double quote character in a
  1836. file name.
  1837.  
  1838.    You may include comments in linker scripts just as in C, delimited by
  1839. `/*' and `*/'.  As in C, comments are syntactically equivalent to
  1840. whitespace.
  1841.  
  1842. 
  1843. File: ld.info,  Node: Simple Example,  Next: Simple Commands,  Prev: Script Format,  Up: Scripts
  1844.  
  1845. 3.3 Simple Linker Script Example
  1846. ================================
  1847.  
  1848. Many linker scripts are fairly simple.
  1849.  
  1850.    The simplest possible linker script has just one command:
  1851. `SECTIONS'.  You use the `SECTIONS' command to describe the memory
  1852. layout of the output file.
  1853.  
  1854.    The `SECTIONS' command is a powerful command.  Here we will describe
  1855. a simple use of it.  Let's assume your program consists only of code,
  1856. initialized data, and uninitialized data.  These will be in the
  1857. `.text', `.data', and `.bss' sections, respectively.  Let's assume
  1858. further that these are the only sections which appear in your input
  1859. files.
  1860.  
  1861.    For this example, let's say that the code should be loaded at address
  1862. 0x10000, and that the data should start at address 0x8000000.  Here is a
  1863. linker script which will do that:
  1864.      SECTIONS
  1865.      {
  1866.        . = 0x10000;
  1867.        .text : { *(.text) }
  1868.        . = 0x8000000;
  1869.        .data : { *(.data) }
  1870.        .bss : { *(.bss) }
  1871.      }
  1872.  
  1873.    You write the `SECTIONS' command as the keyword `SECTIONS', followed
  1874. by a series of symbol assignments and output section descriptions
  1875. enclosed in curly braces.
  1876.  
  1877.    The first line inside the `SECTIONS' command of the above example
  1878. sets the value of the special symbol `.', which is the location
  1879. counter.  If you do not specify the address of an output section in some
  1880. other way (other ways are described later), the address is set from the
  1881. current value of the location counter.  The location counter is then
  1882. incremented by the size of the output section.  At the start of the
  1883. `SECTIONS' command, the location counter has the value `0'.
  1884.  
  1885.    The second line defines an output section, `.text'.  The colon is
  1886. required syntax which may be ignored for now.  Within the curly braces
  1887. after the output section name, you list the names of the input sections
  1888. which should be placed into this output section.  The `*' is a wildcard
  1889. which matches any file name.  The expression `*(.text)' means all
  1890. `.text' input sections in all input files.
  1891.  
  1892.    Since the location counter is `0x10000' when the output section
  1893. `.text' is defined, the linker will set the address of the `.text'
  1894. section in the output file to be `0x10000'.
  1895.  
  1896.    The remaining lines define the `.data' and `.bss' sections in the
  1897. output file.  The linker will place the `.data' output section at
  1898. address `0x8000000'.  After the linker places the `.data' output
  1899. section, the value of the location counter will be `0x8000000' plus the
  1900. size of the `.data' output section.  The effect is that the linker will
  1901. place the `.bss' output section immediately after the `.data' output
  1902. section in memory.
  1903.  
  1904.    The linker will ensure that each output section has the required
  1905. alignment, by increasing the location counter if necessary.  In this
  1906. example, the specified addresses for the `.text' and `.data' sections
  1907. will probably satisfy any alignment constraints, but the linker may
  1908. have to create a small gap between the `.data' and `.bss' sections.
  1909.  
  1910.    That's it!  That's a simple and complete linker script.
  1911.  
  1912. 
  1913. File: ld.info,  Node: Simple Commands,  Next: Assignments,  Prev: Simple Example,  Up: Scripts
  1914.  
  1915. 3.4 Simple Linker Script Commands
  1916. =================================
  1917.  
  1918. In this section we describe the simple linker script commands.
  1919.  
  1920. * Menu:
  1921.  
  1922. * Entry Point::            Setting the entry point
  1923. * File Commands::        Commands dealing with files
  1924.  
  1925. * Format Commands::        Commands dealing with object file formats
  1926.  
  1927. * Miscellaneous Commands::    Other linker script commands
  1928.  
  1929. 
  1930. File: ld.info,  Node: Entry Point,  Next: File Commands,  Up: Simple Commands
  1931.  
  1932. 3.4.1 Setting the Entry Point
  1933. -----------------------------
  1934.  
  1935. The first instruction to execute in a program is called the "entry
  1936. point".  You can use the `ENTRY' linker script command to set the entry
  1937. point.  The argument is a symbol name:
  1938.      ENTRY(SYMBOL)
  1939.  
  1940.    There are several ways to set the entry point.  The linker will set
  1941. the entry point by trying each of the following methods in order, and
  1942. stopping when one of them succeeds:
  1943.    * the `-e' ENTRY command-line option;
  1944.  
  1945.    * the `ENTRY(SYMBOL)' command in a linker script;
  1946.  
  1947.    * the value of the symbol `start', if defined;
  1948.  
  1949.    * the address of the first byte of the `.text' section, if present;
  1950.  
  1951.    * The address `0'.
  1952.  
  1953. 
  1954. File: ld.info,  Node: File Commands,  Next: Format Commands,  Prev: Entry Point,  Up: Simple Commands
  1955.  
  1956. 3.4.2 Commands Dealing with Files
  1957. ---------------------------------
  1958.  
  1959. Several linker script commands deal with files.
  1960.  
  1961. `INCLUDE FILENAME'
  1962.      Include the linker script FILENAME at this point.  The file will
  1963.      be searched for in the current directory, and in any directory
  1964.      specified with the `-L' option.  You can nest calls to `INCLUDE'
  1965.      up to 10 levels deep.
  1966.  
  1967. `INPUT(FILE, FILE, ...)'
  1968. `INPUT(FILE FILE ...)'
  1969.      The `INPUT' command directs the linker to include the named files
  1970.      in the link, as though they were named on the command line.
  1971.  
  1972.      For example, if you always want to include `subr.o' any time you do
  1973.      a link, but you can't be bothered to put it on every link command
  1974.      line, then you can put `INPUT (subr.o)' in your linker script.
  1975.  
  1976.      In fact, if you like, you can list all of your input files in the
  1977.      linker script, and then invoke the linker with nothing but a `-T'
  1978.      option.
  1979.  
  1980.      In case a "sysroot prefix" is configured, and the filename starts
  1981.      with the `/' character, and the script being processed was located
  1982.      inside the "sysroot prefix", the filename will be looked for in
  1983.      the "sysroot prefix".  Otherwise, the linker will try to open the
  1984.      file in the current directory.  If it is not found, the linker
  1985.      will search through the archive library search path.  See the
  1986.      description of `-L' in *Note Command Line Options: Options.
  1987.  
  1988.      If you use `INPUT (-lFILE)', `ld' will transform the name to
  1989.      `libFILE.a', as with the command line argument `-l'.
  1990.  
  1991.      When you use the `INPUT' command in an implicit linker script, the
  1992.      files will be included in the link at the point at which the linker
  1993.      script file is included.  This can affect archive searching.
  1994.  
  1995. `GROUP(FILE, FILE, ...)'
  1996. `GROUP(FILE FILE ...)'
  1997.      The `GROUP' command is like `INPUT', except that the named files
  1998.      should all be archives, and they are searched repeatedly until no
  1999.      new undefined references are created.  See the description of `-('
  2000.      in *Note Command Line Options: Options.
  2001.  
  2002. `AS_NEEDED(FILE, FILE, ...)'
  2003. `AS_NEEDED(FILE FILE ...)'
  2004.      This construct can appear only inside of the `INPUT' or `GROUP'
  2005.      commands, among other filenames.  The files listed will be handled
  2006.      as if they appear directly in the `INPUT' or `GROUP' commands,
  2007.      with the exception of ELF shared libraries, that will be added only
  2008.      when they are actually needed.  This construct essentially enables
  2009.      `--as-needed' option for all the files listed inside of it and
  2010.      restores previous `--as-needed' resp. `--no-as-needed' setting
  2011.      afterwards.
  2012.  
  2013. `OUTPUT(FILENAME)'
  2014.      The `OUTPUT' command names the output file.  Using
  2015.      `OUTPUT(FILENAME)' in the linker script is exactly like using `-o
  2016.      FILENAME' on the command line (*note Command Line Options:
  2017.      Options.).  If both are used, the command line option takes
  2018.      precedence.
  2019.  
  2020.      You can use the `OUTPUT' command to define a default name for the
  2021.      output file other than the usual default of `a.out'.
  2022.  
  2023. `SEARCH_DIR(PATH)'
  2024.      The `SEARCH_DIR' command adds PATH to the list of paths where `ld'
  2025.      looks for archive libraries.  Using `SEARCH_DIR(PATH)' is exactly
  2026.      like using `-L PATH' on the command line (*note Command Line
  2027.      Options: Options.).  If both are used, then the linker will search
  2028.      both paths.  Paths specified using the command line option are
  2029.      searched first.
  2030.  
  2031. `STARTUP(FILENAME)'
  2032.      The `STARTUP' command is just like the `INPUT' command, except
  2033.      that FILENAME will become the first input file to be linked, as
  2034.      though it were specified first on the command line.  This may be
  2035.      useful when using a system in which the entry point is always the
  2036.      start of the first file.
  2037.  
  2038. 
  2039. File: ld.info,  Node: Format Commands,  Next: Miscellaneous Commands,  Prev: File Commands,  Up: Simple Commands
  2040.  
  2041. 3.4.3 Commands Dealing with Object File Formats
  2042. -----------------------------------------------
  2043.  
  2044. A couple of linker script commands deal with object file formats.
  2045.  
  2046. `OUTPUT_FORMAT(BFDNAME)'
  2047. `OUTPUT_FORMAT(DEFAULT, BIG, LITTLE)'
  2048.      The `OUTPUT_FORMAT' command names the BFD format to use for the
  2049.      output file (*note BFD::).  Using `OUTPUT_FORMAT(BFDNAME)' is
  2050.      exactly like using `--oformat BFDNAME' on the command line (*note
  2051.      Command Line Options: Options.).  If both are used, the command
  2052.      line option takes precedence.
  2053.  
  2054.      You can use `OUTPUT_FORMAT' with three arguments to use different
  2055.      formats based on the `-EB' and `-EL' command line options.  This
  2056.      permits the linker script to set the output format based on the
  2057.      desired endianness.
  2058.  
  2059.      If neither `-EB' nor `-EL' are used, then the output format will
  2060.      be the first argument, DEFAULT.  If `-EB' is used, the output
  2061.      format will be the second argument, BIG.  If `-EL' is used, the
  2062.      output format will be the third argument, LITTLE.
  2063.  
  2064.      For example, the default linker script for the MIPS ELF target
  2065.      uses this command:
  2066.           OUTPUT_FORMAT(elf32-bigmips, elf32-bigmips, elf32-littlemips)
  2067.      This says that the default format for the output file is
  2068.      `elf32-bigmips', but if the user uses the `-EL' command line
  2069.      option, the output file will be created in the `elf32-littlemips'
  2070.      format.
  2071.  
  2072. `TARGET(BFDNAME)'
  2073.      The `TARGET' command names the BFD format to use when reading input
  2074.      files.  It affects subsequent `INPUT' and `GROUP' commands.  This
  2075.      command is like using `-b BFDNAME' on the command line (*note
  2076.      Command Line Options: Options.).  If the `TARGET' command is used
  2077.      but `OUTPUT_FORMAT' is not, then the last `TARGET' command is also
  2078.      used to set the format for the output file.  *Note BFD::.
  2079.  
  2080. 
  2081. File: ld.info,  Node: Miscellaneous Commands,  Prev: Format Commands,  Up: Simple Commands
  2082.  
  2083. 3.4.4 Other Linker Script Commands
  2084. ----------------------------------
  2085.  
  2086. There are a few other linker scripts commands.
  2087.  
  2088. `ASSERT(EXP, MESSAGE)'
  2089.      Ensure that EXP is non-zero.  If it is zero, then exit the linker
  2090.      with an error code, and print MESSAGE.
  2091.  
  2092. `EXTERN(SYMBOL SYMBOL ...)'
  2093.      Force SYMBOL to be entered in the output file as an undefined
  2094.      symbol.  Doing this may, for example, trigger linking of additional
  2095.      modules from standard libraries.  You may list several SYMBOLs for
  2096.      each `EXTERN', and you may use `EXTERN' multiple times.  This
  2097.      command has the same effect as the `-u' command-line option.
  2098.  
  2099. `FORCE_COMMON_ALLOCATION'
  2100.      This command has the same effect as the `-d' command-line option:
  2101.      to make `ld' assign space to common symbols even if a relocatable
  2102.      output file is specified (`-r').
  2103.  
  2104. `INHIBIT_COMMON_ALLOCATION'
  2105.      This command has the same effect as the `--no-define-common'
  2106.      command-line option: to make `ld' omit the assignment of addresses
  2107.      to common symbols even for a non-relocatable output file.
  2108.  
  2109. `NOCROSSREFS(SECTION SECTION ...)'
  2110.      This command may be used to tell `ld' to issue an error about any
  2111.      references among certain output sections.
  2112.  
  2113.      In certain types of programs, particularly on embedded systems when
  2114.      using overlays, when one section is loaded into memory, another
  2115.      section will not be.  Any direct references between the two
  2116.      sections would be errors.  For example, it would be an error if
  2117.      code in one section called a function defined in the other section.
  2118.  
  2119.      The `NOCROSSREFS' command takes a list of output section names.  If
  2120.      `ld' detects any cross references between the sections, it reports
  2121.      an error and returns a non-zero exit status.  Note that the
  2122.      `NOCROSSREFS' command uses output section names, not input section
  2123.      names.
  2124.  
  2125. `OUTPUT_ARCH(BFDARCH)'
  2126.      Specify a particular output machine architecture.  The argument is
  2127.      one of the names used by the BFD library (*note BFD::).  You can
  2128.      see the architecture of an object file by using the `objdump'
  2129.      program with the `-f' option.
  2130.  
  2131. 
  2132. File: ld.info,  Node: Assignments,  Next: SECTIONS,  Prev: Simple Commands,  Up: Scripts
  2133.  
  2134. 3.5 Assigning Values to Symbols
  2135. ===============================
  2136.  
  2137. You may assign a value to a symbol in a linker script.  This will define
  2138. the symbol and place it into the symbol table with a global scope.
  2139.  
  2140. * Menu:
  2141.  
  2142. * Simple Assignments::        Simple Assignments
  2143. * PROVIDE::            PROVIDE
  2144. * Source Code Reference::    How to use a linker script defined symbol in source code
  2145.  
  2146. 
  2147. File: ld.info,  Node: Simple Assignments,  Next: PROVIDE,  Up: Assignments
  2148.  
  2149. 3.5.1 Simple Assignments
  2150. ------------------------
  2151.  
  2152. You may assign to a symbol using any of the C assignment operators:
  2153.  
  2154. `SYMBOL = EXPRESSION ;'
  2155. `SYMBOL += EXPRESSION ;'
  2156. `SYMBOL -= EXPRESSION ;'
  2157. `SYMBOL *= EXPRESSION ;'
  2158. `SYMBOL /= EXPRESSION ;'
  2159. `SYMBOL <<= EXPRESSION ;'
  2160. `SYMBOL >>= EXPRESSION ;'
  2161. `SYMBOL &= EXPRESSION ;'
  2162. `SYMBOL |= EXPRESSION ;'
  2163.  
  2164.    The first case will define SYMBOL to the value of EXPRESSION.  In
  2165. the other cases, SYMBOL must already be defined, and the value will be
  2166. adjusted accordingly.
  2167.  
  2168.    The special symbol name `.' indicates the location counter.  You may
  2169. only use this within a `SECTIONS' command.  *Note Location Counter::.
  2170.  
  2171.    The semicolon after EXPRESSION is required.
  2172.  
  2173.    Expressions are defined below; see *Note Expressions::.
  2174.  
  2175.    You may write symbol assignments as commands in their own right, or
  2176. as statements within a `SECTIONS' command, or as part of an output
  2177. section description in a `SECTIONS' command.
  2178.  
  2179.    The section of the symbol will be set from the section of the
  2180. expression; for more information, see *Note Expression Section::.
  2181.  
  2182.    Here is an example showing the three different places that symbol
  2183. assignments may be used:
  2184.  
  2185.      floating_point = 0;
  2186.      SECTIONS
  2187.      {
  2188.        .text :
  2189.          {
  2190.            *(.text)
  2191.            _etext = .;
  2192.          }
  2193.        _bdata = (. + 3) & ~ 3;
  2194.        .data : { *(.data) }
  2195.      }
  2196.    In this example, the symbol `floating_point' will be defined as
  2197. zero.  The symbol `_etext' will be defined as the address following the
  2198. last `.text' input section.  The symbol `_bdata' will be defined as the
  2199. address following the `.text' output section aligned upward to a 4 byte
  2200. boundary.
  2201.  
  2202. 
  2203. File: ld.info,  Node: PROVIDE,  Next: Source Code Reference,  Prev: Simple Assignments,  Up: Assignments
  2204.  
  2205. 3.5.2 PROVIDE
  2206. -------------
  2207.  
  2208. In some cases, it is desirable for a linker script to define a symbol
  2209. only if it is referenced and is not defined by any object included in
  2210. the link.  For example, traditional linkers defined the symbol `etext'.
  2211. However, ANSI C requires that the user be able to use `etext' as a
  2212. function name without encountering an error.  The `PROVIDE' keyword may
  2213. be used to define a symbol, such as `etext', only if it is referenced
  2214. but not defined.  The syntax is `PROVIDE(SYMBOL = EXPRESSION)'.
  2215.  
  2216.    Here is an example of using `PROVIDE' to define `etext':
  2217.      SECTIONS
  2218.      {
  2219.        .text :
  2220.          {
  2221.            *(.text)
  2222.            _etext = .;
  2223.            PROVIDE(etext = .);
  2224.          }
  2225.      }
  2226.  
  2227.    In this example, if the program defines `_etext' (with a leading
  2228. underscore), the linker will give a multiple definition error.  If, on
  2229. the other hand, the program defines `etext' (with no leading
  2230. underscore), the linker will silently use the definition in the program.
  2231. If the program references `etext' but does not define it, the linker
  2232. will use the definition in the linker script.
  2233.  
  2234. 
  2235. File: ld.info,  Node: Source Code Reference,  Prev: PROVIDE,  Up: Assignments
  2236.  
  2237. 3.5.3 Source Code Reference
  2238. ---------------------------
  2239.  
  2240. Accessing a linker script defined variable from source code is not
  2241. intuitive.  In particular a linker script symbol is not equivalent to a
  2242. variable declaration in a high level language, it is instead a symbol
  2243. that does not have a value.
  2244.  
  2245.    Before going further, it is important to note that compilers often
  2246. transform names in the source code into different names when they are
  2247. stored in the symbol table.  For example, Fortran compilers commonly
  2248. prepend or append an underscore, and C++ performs extensive `name
  2249. mangling'.  Therefore there might be a discrepancy between the name of
  2250. a variable as it is used in source code and the name of the same
  2251. variable as it is defined in a linker script.  For example in C a
  2252. linker script variable might be referred to as:
  2253.  
  2254.        extern int foo;
  2255.  
  2256.    But in the linker script it might be defined as:
  2257.  
  2258.        _foo = 1000;
  2259.  
  2260.    In the remaining examples however it is assumed that no name
  2261. transformation has taken place.
  2262.  
  2263.    When a symbol is declared in a high level language such as C, two
  2264. things happen.  The first is that the compiler reserves enough space in
  2265. the program's memory to hold the _value_ of the symbol.  The second is
  2266. that the compiler creates an entry in the program's symbol table which
  2267. holds the symbol's _address_.  ie the symbol table contains the address
  2268. of the block of memory holding the symbol's value.  So for example the
  2269. following C declaration, at file scope:
  2270.  
  2271.        int foo = 1000;
  2272.  
  2273.    creates a entry called `foo' in the symbol table.  This entry holds
  2274. the address of an `int' sized block of memory where the number 1000 is
  2275. initially stored.
  2276.  
  2277.    When a program references a symbol the compiler generates code that
  2278. first accesses the symbol table to find the address of the symbol's
  2279. memory block and then code to read the value from that memory block.
  2280. So:
  2281.  
  2282.        foo = 1;
  2283.  
  2284.    looks up the symbol `foo' in the symbol table, gets the address
  2285. associated with this symbol and then writes the value 1 into that
  2286. address.  Whereas:
  2287.  
  2288.        int * a = & foo;
  2289.  
  2290.    looks up the symbol `foo' in the symbol table, gets it address and
  2291. then copies this address into the block of memory associated with the
  2292. variable `a'.
  2293.  
  2294.    Linker scripts symbol declarations, by contrast, create an entry in
  2295. the symbol table but do not assign any memory to them.  Thus they are
  2296. an address without a value.  So for example the linker script
  2297. definition:
  2298.  
  2299.        foo = 1000;
  2300.  
  2301.    creates an entry in the symbol table called `foo' which holds the
  2302. address of memory location 1000, but nothing special is stored at
  2303. address 1000.  This means that you cannot access the _value_ of a
  2304. linker script defined symbol - it has no value - all you can do is
  2305. access the _address_ of a linker script defined symbol.
  2306.  
  2307.    Hence when you are using a linker script defined symbol in source
  2308. code you should always take the address of the symbol, and never
  2309. attempt to use its value.  For example suppose you want to copy the
  2310. contents of a section of memory called .ROM into a section called
  2311. .FLASH and the linker script contains these declarations:
  2312.  
  2313.        start_of_ROM   = .ROM;
  2314.        end_of_ROM     = .ROM + sizeof (.ROM) - 1;
  2315.        start_of_FLASH = .FLASH;
  2316.  
  2317.    Then the C source code to perform the copy would be:
  2318.  
  2319.        extern char start_of_ROM, end_of_ROM, start_of_FLASH;
  2320.  
  2321.        memcpy (& start_of_FLASH, & start_of_ROM, & end_of_ROM - & start_of_ROM);
  2322.  
  2323.    Note the use of the `&' operators.  These are correct.
  2324.  
  2325. 
  2326. File: ld.info,  Node: SECTIONS,  Next: MEMORY,  Prev: Assignments,  Up: Scripts
  2327.  
  2328. 3.6 SECTIONS Command
  2329. ====================
  2330.  
  2331. The `SECTIONS' command tells the linker how to map input sections into
  2332. output sections, and how to place the output sections in memory.
  2333.  
  2334.    The format of the `SECTIONS' command is:
  2335.      SECTIONS
  2336.      {
  2337.        SECTIONS-COMMAND
  2338.        SECTIONS-COMMAND
  2339.        ...
  2340.      }
  2341.  
  2342.    Each SECTIONS-COMMAND may of be one of the following:
  2343.  
  2344.    * an `ENTRY' command (*note Entry command: Entry Point.)
  2345.  
  2346.    * a symbol assignment (*note Assignments::)
  2347.  
  2348.    * an output section description
  2349.  
  2350.    * an overlay description
  2351.  
  2352.    The `ENTRY' command and symbol assignments are permitted inside the
  2353. `SECTIONS' command for convenience in using the location counter in
  2354. those commands.  This can also make the linker script easier to
  2355. understand because you can use those commands at meaningful points in
  2356. the layout of the output file.
  2357.  
  2358.    Output section descriptions and overlay descriptions are described
  2359. below.
  2360.  
  2361.    If you do not use a `SECTIONS' command in your linker script, the
  2362. linker will place each input section into an identically named output
  2363. section in the order that the sections are first encountered in the
  2364. input files.  If all input sections are present in the first file, for
  2365. example, the order of sections in the output file will match the order
  2366. in the first input file.  The first section will be at address zero.
  2367.  
  2368. * Menu:
  2369.  
  2370. * Output Section Description::    Output section description
  2371. * Output Section Name::        Output section name
  2372. * Output Section Address::    Output section address
  2373. * Input Section::        Input section description
  2374. * Output Section Data::        Output section data
  2375. * Output Section Keywords::    Output section keywords
  2376. * Output Section Discarding::    Output section discarding
  2377. * Output Section Attributes::    Output section attributes
  2378. * Overlay Description::        Overlay description
  2379.  
  2380. 
  2381. File: ld.info,  Node: Output Section Description,  Next: Output Section Name,  Up: SECTIONS
  2382.  
  2383. 3.6.1 Output Section Description
  2384. --------------------------------
  2385.  
  2386. The full description of an output section looks like this:
  2387.      SECTION [ADDRESS] [(TYPE)] :
  2388.        [AT(LMA)] [SUBALIGN(SUBSECTION_ALIGN)]
  2389.        {
  2390.          OUTPUT-SECTION-COMMAND
  2391.          OUTPUT-SECTION-COMMAND
  2392.          ...
  2393.        } [>REGION] [AT>LMA_REGION] [:PHDR :PHDR ...] [=FILLEXP]
  2394.  
  2395.    Most output sections do not use most of the optional section
  2396. attributes.
  2397.  
  2398.    The whitespace around SECTION is required, so that the section name
  2399. is unambiguous.  The colon and the curly braces are also required.  The
  2400. line breaks and other white space are optional.
  2401.  
  2402.    Each OUTPUT-SECTION-COMMAND may be one of the following:
  2403.  
  2404.    * a symbol assignment (*note Assignments::)
  2405.  
  2406.    * an input section description (*note Input Section::)
  2407.  
  2408.    * data values to include directly (*note Output Section Data::)
  2409.  
  2410.    * a special output section keyword (*note Output Section Keywords::)
  2411.  
  2412. 
  2413. File: ld.info,  Node: Output Section Name,  Next: Output Section Address,  Prev: Output Section Description,  Up: SECTIONS
  2414.  
  2415. 3.6.2 Output Section Name
  2416. -------------------------
  2417.  
  2418. The name of the output section is SECTION.  SECTION must meet the
  2419. constraints of your output format.  In formats which only support a
  2420. limited number of sections, such as `a.out', the name must be one of
  2421. the names supported by the format (`a.out', for example, allows only
  2422. `.text', `.data' or `.bss'). If the output format supports any number
  2423. of sections, but with numbers and not names (as is the case for Oasys),
  2424. the name should be supplied as a quoted numeric string.  A section name
  2425. may consist of any sequence of characters, but a name which contains
  2426. any unusual characters such as commas must be quoted.
  2427.  
  2428.    The output section name `/DISCARD/' is special; *Note Output Section
  2429. Discarding::.
  2430.  
  2431. 
  2432. File: ld.info,  Node: Output Section Address,  Next: Input Section,  Prev: Output Section Name,  Up: SECTIONS
  2433.  
  2434. 3.6.3 Output Section Address
  2435. ----------------------------
  2436.  
  2437. The ADDRESS is an expression for the VMA (the virtual memory address)
  2438. of the output section.  If you do not provide ADDRESS, the linker will
  2439. set it based on REGION if present, or otherwise based on the current
  2440. value of the location counter.
  2441.  
  2442.    If you provide ADDRESS, the address of the output section will be
  2443. set to precisely that.  If you provide neither ADDRESS nor REGION, then
  2444. the address of the output section will be set to the current value of
  2445. the location counter aligned to the alignment requirements of the
  2446. output section.  The alignment requirement of the output section is the
  2447. strictest alignment of any input section contained within the output
  2448. section.
  2449.  
  2450.    For example,
  2451.      .text . : { *(.text) }
  2452.    and
  2453.      .text : { *(.text) }
  2454.    are subtly different.  The first will set the address of the `.text'
  2455. output section to the current value of the location counter.  The
  2456. second will set it to the current value of the location counter aligned
  2457. to the strictest alignment of a `.text' input section.
  2458.  
  2459.    The ADDRESS may be an arbitrary expression; *Note Expressions::.
  2460. For example, if you want to align the section on a 0x10 byte boundary,
  2461. so that the lowest four bits of the section address are zero, you could
  2462. do something like this:
  2463.      .text ALIGN(0x10) : { *(.text) }
  2464.    This works because `ALIGN' returns the current location counter
  2465. aligned upward to the specified value.
  2466.  
  2467.    Specifying ADDRESS for a section will change the value of the
  2468. location counter.
  2469.  
  2470. 
  2471. File: ld.info,  Node: Input Section,  Next: Output Section Data,  Prev: Output Section Address,  Up: SECTIONS
  2472.  
  2473. 3.6.4 Input Section Description
  2474. -------------------------------
  2475.  
  2476. The most common output section command is an input section description.
  2477.  
  2478.    The input section description is the most basic linker script
  2479. operation.  You use output sections to tell the linker how to lay out
  2480. your program in memory.  You use input section descriptions to tell the
  2481. linker how to map the input files into your memory layout.
  2482.  
  2483. * Menu:
  2484.  
  2485. * Input Section Basics::    Input section basics
  2486. * Input Section Wildcards::    Input section wildcard patterns
  2487. * Input Section Common::    Input section for common symbols
  2488. * Input Section Keep::        Input section and garbage collection
  2489. * Input Section Example::    Input section example
  2490.  
  2491. 
  2492. File: ld.info,  Node: Input Section Basics,  Next: Input Section Wildcards,  Up: Input Section
  2493.  
  2494. 3.6.4.1 Input Section Basics
  2495. ............................
  2496.  
  2497. An input section description consists of a file name optionally followed
  2498. by a list of section names in parentheses.
  2499.  
  2500.    The file name and the section name may be wildcard patterns, which we
  2501. describe further below (*note Input Section Wildcards::).
  2502.  
  2503.    The most common input section description is to include all input
  2504. sections with a particular name in the output section.  For example, to
  2505. include all input `.text' sections, you would write:
  2506.      *(.text)
  2507.    Here the `*' is a wildcard which matches any file name.  To exclude
  2508. a list of files from matching the file name wildcard, EXCLUDE_FILE may
  2509. be used to match all files except the ones specified in the
  2510. EXCLUDE_FILE list.  For example:
  2511.      (*(EXCLUDE_FILE (*crtend.o *otherfile.o) .ctors))
  2512.    will cause all .ctors sections from all files except `crtend.o' and
  2513. `otherfile.o' to be included.
  2514.  
  2515.    There are two ways to include more than one section:
  2516.      *(.text .rdata)
  2517.      *(.text) *(.rdata)
  2518.    The difference between these is the order in which the `.text' and
  2519. `.rdata' input sections will appear in the output section.  In the
  2520. first example, they will be intermingled, appearing in the same order as
  2521. they are found in the linker input.  In the second example, all `.text'
  2522. input sections will appear first, followed by all `.rdata' input
  2523. sections.
  2524.  
  2525.    You can specify a file name to include sections from a particular
  2526. file.  You would do this if one or more of your files contain special
  2527. data that needs to be at a particular location in memory.  For example:
  2528.      data.o(.data)
  2529.  
  2530.    If you use a file name without a list of sections, then all sections
  2531. in the input file will be included in the output section.  This is not
  2532. commonly done, but it may by useful on occasion.  For example:
  2533.      data.o
  2534.  
  2535.    When you use a file name which does not contain any wild card
  2536. characters, the linker will first see if you also specified the file
  2537. name on the linker command line or in an `INPUT' command.  If you did
  2538. not, the linker will attempt to open the file as an input file, as
  2539. though it appeared on the command line.  Note that this differs from an
  2540. `INPUT' command, because the linker will not search for the file in the
  2541. archive search path.
  2542.  
  2543. 
  2544. File: ld.info,  Node: Input Section Wildcards,  Next: Input Section Common,  Prev: Input Section Basics,  Up: Input Section
  2545.  
  2546. 3.6.4.2 Input Section Wildcard Patterns
  2547. .......................................
  2548.  
  2549. In an input section description, either the file name or the section
  2550. name or both may be wildcard patterns.
  2551.  
  2552.    The file name of `*' seen in many examples is a simple wildcard
  2553. pattern for the file name.
  2554.  
  2555.    The wildcard patterns are like those used by the Unix shell.
  2556.  
  2557. `*'
  2558.      matches any number of characters
  2559.  
  2560. `?'
  2561.      matches any single character
  2562.  
  2563. `[CHARS]'
  2564.      matches a single instance of any of the CHARS; the `-' character
  2565.      may be used to specify a range of characters, as in `[a-z]' to
  2566.      match any lower case letter
  2567.  
  2568. `\'
  2569.      quotes the following character
  2570.  
  2571.    When a file name is matched with a wildcard, the wildcard characters
  2572. will not match a `/' character (used to separate directory names on
  2573. Unix).  A pattern consisting of a single `*' character is an exception;
  2574. it will always match any file name, whether it contains a `/' or not.
  2575. In a section name, the wildcard characters will match a `/' character.
  2576.  
  2577.    File name wildcard patterns only match files which are explicitly
  2578. specified on the command line or in an `INPUT' command.  The linker
  2579. does not search directories to expand wildcards.
  2580.  
  2581.    If a file name matches more than one wildcard pattern, or if a file
  2582. name appears explicitly and is also matched by a wildcard pattern, the
  2583. linker will use the first match in the linker script.  For example, this
  2584. sequence of input section descriptions is probably in error, because the
  2585. `data.o' rule will not be used:
  2586.      .data : { *(.data) }
  2587.      .data1 : { data.o(.data) }
  2588.  
  2589.    Normally, the linker will place files and sections matched by
  2590. wildcards in the order in which they are seen during the link.  You can
  2591. change this by using the `SORT_BY_NAME' keyword, which appears before a
  2592. wildcard pattern in parentheses (e.g., `SORT_BY_NAME(.text*)').  When
  2593. the `SORT_BY_NAME' keyword is used, the linker will sort the files or
  2594. sections into ascending order by name before placing them in the output
  2595. file.
  2596.  
  2597.    `SORT_BY_ALIGNMENT' is very similar to `SORT_BY_NAME'. The
  2598. difference is `SORT_BY_ALIGNMENT' will sort sections into ascending
  2599. order by alignment before placing them in the output file.
  2600.  
  2601.    `SORT' is an alias for `SORT_BY_NAME'.
  2602.  
  2603.    When there are nested section sorting commands in linker script,
  2604. there can be at most 1 level of nesting for section sorting commands.
  2605.  
  2606.   1. `SORT_BY_NAME' (`SORT_BY_ALIGNMENT' (wildcard section pattern)).
  2607.      It will sort the input sections by name first, then by alignment
  2608.      if 2 sections have the same name.
  2609.  
  2610.   2. `SORT_BY_ALIGNMENT' (`SORT_BY_NAME' (wildcard section pattern)).
  2611.      It will sort the input sections by alignment first, then by name
  2612.      if 2 sections have the same alignment.
  2613.  
  2614.   3. `SORT_BY_NAME' (`SORT_BY_NAME' (wildcard section pattern)) is
  2615.      treated the same as `SORT_BY_NAME' (wildcard section pattern).
  2616.  
  2617.   4. `SORT_BY_ALIGNMENT' (`SORT_BY_ALIGNMENT' (wildcard section
  2618.      pattern)) is treated the same as `SORT_BY_ALIGNMENT' (wildcard
  2619.      section pattern).
  2620.  
  2621.   5. All other nested section sorting commands are invalid.
  2622.  
  2623.    When both command line section sorting option and linker script
  2624. section sorting command are used, section sorting command always takes
  2625. precedence over the command line option.
  2626.  
  2627.    If the section sorting command in linker script isn't nested, the
  2628. command line option will make the section sorting command to be treated
  2629. as nested sorting command.
  2630.  
  2631.   1. `SORT_BY_NAME' (wildcard section pattern ) with `--sort-sections
  2632.      alignment' is equivalent to `SORT_BY_NAME' (`SORT_BY_ALIGNMENT'
  2633.      (wildcard section pattern)).
  2634.  
  2635.   2. `SORT_BY_ALIGNMENT' (wildcard section pattern) with
  2636.      `--sort-section name' is equivalent to `SORT_BY_ALIGNMENT'
  2637.      (`SORT_BY_NAME' (wildcard section pattern)).
  2638.  
  2639.    If the section sorting command in linker script is nested, the
  2640. command line option will be ignored.
  2641.  
  2642.    If you ever get confused about where input sections are going, use
  2643. the `-M' linker option to generate a map file.  The map file shows
  2644. precisely how input sections are mapped to output sections.
  2645.  
  2646.    This example shows how wildcard patterns might be used to partition
  2647. files.  This linker script directs the linker to place all `.text'
  2648. sections in `.text' and all `.bss' sections in `.bss'.  The linker will
  2649. place the `.data' section from all files beginning with an upper case
  2650. character in `.DATA'; for all other files, the linker will place the
  2651. `.data' section in `.data'.
  2652.      SECTIONS {
  2653.        .text : { *(.text) }
  2654.        .DATA : { [A-Z]*(.data) }
  2655.        .data : { *(.data) }
  2656.        .bss : { *(.bss) }
  2657.      }
  2658.  
  2659. 
  2660. File: ld.info,  Node: Input Section Common,  Next: Input Section Keep,  Prev: Input Section Wildcards,  Up: Input Section
  2661.  
  2662. 3.6.4.3 Input Section for Common Symbols
  2663. ........................................
  2664.  
  2665. A special notation is needed for common symbols, because in many object
  2666. file formats common symbols do not have a particular input section.  The
  2667. linker treats common symbols as though they are in an input section
  2668. named `COMMON'.
  2669.  
  2670.    You may use file names with the `COMMON' section just as with any
  2671. other input sections.  You can use this to place common symbols from a
  2672. particular input file in one section while common symbols from other
  2673. input files are placed in another section.
  2674.  
  2675.    In most cases, common symbols in input files will be placed in the
  2676. `.bss' section in the output file.  For example:
  2677.      .bss { *(.bss) *(COMMON) }
  2678.  
  2679.    Some object file formats have more than one type of common symbol.
  2680. For example, the MIPS ELF object file format distinguishes standard
  2681. common symbols and small common symbols.  In this case, the linker will
  2682. use a different special section name for other types of common symbols.
  2683. In the case of MIPS ELF, the linker uses `COMMON' for standard common
  2684. symbols and `.scommon' for small common symbols.  This permits you to
  2685. map the different types of common symbols into memory at different
  2686. locations.
  2687.  
  2688.    You will sometimes see `[COMMON]' in old linker scripts.  This
  2689. notation is now considered obsolete.  It is equivalent to `*(COMMON)'.
  2690.  
  2691. 
  2692. File: ld.info,  Node: Input Section Keep,  Next: Input Section Example,  Prev: Input Section Common,  Up: Input Section
  2693.  
  2694. 3.6.4.4 Input Section and Garbage Collection
  2695. ............................................
  2696.  
  2697. When link-time garbage collection is in use (`--gc-sections'), it is
  2698. often useful to mark sections that should not be eliminated.  This is
  2699. accomplished by surrounding an input section's wildcard entry with
  2700. `KEEP()', as in `KEEP(*(.init))' or `KEEP(SORT_BY_NAME(*)(.ctors))'.
  2701.  
  2702. 
  2703. File: ld.info,  Node: Input Section Example,  Prev: Input Section Keep,  Up: Input Section
  2704.  
  2705. 3.6.4.5 Input Section Example
  2706. .............................
  2707.  
  2708. The following example is a complete linker script.  It tells the linker
  2709. to read all of the sections from file `all.o' and place them at the
  2710. start of output section `outputa' which starts at location `0x10000'.
  2711. All of section `.input1' from file `foo.o' follows immediately, in the
  2712. same output section.  All of section `.input2' from `foo.o' goes into
  2713. output section `outputb', followed by section `.input1' from `foo1.o'.
  2714. All of the remaining `.input1' and `.input2' sections from any files
  2715. are written to output section `outputc'.
  2716.  
  2717.      SECTIONS {
  2718.        outputa 0x10000 :
  2719.          {
  2720.          all.o
  2721.          foo.o (.input1)
  2722.          }
  2723.        outputb :
  2724.          {
  2725.          foo.o (.input2)
  2726.          foo1.o (.input1)
  2727.          }
  2728.        outputc :
  2729.          {
  2730.          *(.input1)
  2731.          *(.input2)
  2732.          }
  2733.      }
  2734.  
  2735. 
  2736. File: ld.info,  Node: Output Section Data,  Next: Output Section Keywords,  Prev: Input Section,  Up: SECTIONS
  2737.  
  2738. 3.6.5 Output Section Data
  2739. -------------------------
  2740.  
  2741. You can include explicit bytes of data in an output section by using
  2742. `BYTE', `SHORT', `LONG', `QUAD', or `SQUAD' as an output section
  2743. command.  Each keyword is followed by an expression in parentheses
  2744. providing the value to store (*note Expressions::).  The value of the
  2745. expression is stored at the current value of the location counter.
  2746.  
  2747.    The `BYTE', `SHORT', `LONG', and `QUAD' commands store one, two,
  2748. four, and eight bytes (respectively).  After storing the bytes, the
  2749. location counter is incremented by the number of bytes stored.
  2750.  
  2751.    For example, this will store the byte 1 followed by the four byte
  2752. value of the symbol `addr':
  2753.      BYTE(1)
  2754.      LONG(addr)
  2755.  
  2756.    When using a 64 bit host or target, `QUAD' and `SQUAD' are the same;
  2757. they both store an 8 byte, or 64 bit, value.  When both host and target
  2758. are 32 bits, an expression is computed as 32 bits.  In this case `QUAD'
  2759. stores a 32 bit value zero extended to 64 bits, and `SQUAD' stores a 32
  2760. bit value sign extended to 64 bits.
  2761.  
  2762.    If the object file format of the output file has an explicit
  2763. endianness, which is the normal case, the value will be stored in that
  2764. endianness.  When the object file format does not have an explicit
  2765. endianness, as is true of, for example, S-records, the value will be
  2766. stored in the endianness of the first input object file.
  2767.  
  2768.    Note--these commands only work inside a section description and not
  2769. between them, so the following will produce an error from the linker:
  2770.      SECTIONS { .text : { *(.text) } LONG(1) .data : { *(.data) } }
  2771.    whereas this will work:
  2772.      SECTIONS { .text : { *(.text) ; LONG(1) } .data : { *(.data) } }
  2773.  
  2774.    You may use the `FILL' command to set the fill pattern for the
  2775. current section.  It is followed by an expression in parentheses.  Any
  2776. otherwise unspecified regions of memory within the section (for example,
  2777. gaps left due to the required alignment of input sections) are filled
  2778. with the value of the expression, repeated as necessary.  A `FILL'
  2779. statement covers memory locations after the point at which it occurs in
  2780. the section definition; by including more than one `FILL' statement,
  2781. you can have different fill patterns in different parts of an output
  2782. section.
  2783.  
  2784.    This example shows how to fill unspecified regions of memory with the
  2785. value `0x90':
  2786.      FILL(0x90909090)
  2787.  
  2788.    The `FILL' command is similar to the `=FILLEXP' output section
  2789. attribute, but it only affects the part of the section following the
  2790. `FILL' command, rather than the entire section.  If both are used, the
  2791. `FILL' command takes precedence.  *Note Output Section Fill::, for
  2792. details on the fill expression.
  2793.  
  2794. 
  2795. File: ld.info,  Node: Output Section Keywords,  Next: Output Section Discarding,  Prev: Output Section Data,  Up: SECTIONS
  2796.  
  2797. 3.6.6 Output Section Keywords
  2798. -----------------------------
  2799.  
  2800. There are a couple of keywords which can appear as output section
  2801. commands.
  2802.  
  2803. `CREATE_OBJECT_SYMBOLS'
  2804.      The command tells the linker to create a symbol for each input
  2805.      file.  The name of each symbol will be the name of the
  2806.      corresponding input file.  The section of each symbol will be the
  2807.      output section in which the `CREATE_OBJECT_SYMBOLS' command
  2808.      appears.
  2809.  
  2810.      This is conventional for the a.out object file format.  It is not
  2811.      normally used for any other object file format.
  2812.  
  2813. `CONSTRUCTORS'
  2814.      When linking using the a.out object file format, the linker uses an
  2815.      unusual set construct to support C++ global constructors and
  2816.      destructors.  When linking object file formats which do not support
  2817.      arbitrary sections, such as ECOFF and XCOFF, the linker will
  2818.      automatically recognize C++ global constructors and destructors by
  2819.      name.  For these object file formats, the `CONSTRUCTORS' command
  2820.      tells the linker to place constructor information in the output
  2821.      section where the `CONSTRUCTORS' command appears.  The
  2822.      `CONSTRUCTORS' command is ignored for other object file formats.
  2823.  
  2824.      The symbol `__CTOR_LIST__' marks the start of the global
  2825.      constructors, and the symbol `__CTOR_END__' marks the end.
  2826.      Similarly, `__DTOR_LIST__' and `__DTOR_END__' mark the start and
  2827.      end of the global destructors.  The first word in the list is the
  2828.      number of entries, followed by the address of each constructor or
  2829.      destructor, followed by a zero word.  The compiler must arrange to
  2830.      actually run the code.  For these object file formats GNU C++
  2831.      normally calls constructors from a subroutine `__main'; a call to
  2832.      `__main' is automatically inserted into the startup code for
  2833.      `main'.  GNU C++ normally runs destructors either by using
  2834.      `atexit', or directly from the function `exit'.
  2835.  
  2836.      For object file formats such as `COFF' or `ELF' which support
  2837.      arbitrary section names, GNU C++ will normally arrange to put the
  2838.      addresses of global constructors and destructors into the `.ctors'
  2839.      and `.dtors' sections.  Placing the following sequence into your
  2840.      linker script will build the sort of table which the GNU C++
  2841.      runtime code expects to see.
  2842.  
  2843.                 __CTOR_LIST__ = .;
  2844.                 LONG((__CTOR_END__ - __CTOR_LIST__) / 4 - 2)
  2845.                 *(.ctors)
  2846.                 LONG(0)
  2847.                 __CTOR_END__ = .;
  2848.                 __DTOR_LIST__ = .;
  2849.                 LONG((__DTOR_END__ - __DTOR_LIST__) / 4 - 2)
  2850.                 *(.dtors)
  2851.                 LONG(0)
  2852.                 __DTOR_END__ = .;
  2853.  
  2854.      If you are using the GNU C++ support for initialization priority,
  2855.      which provides some control over the order in which global
  2856.      constructors are run, you must sort the constructors at link time
  2857.      to ensure that they are executed in the correct order.  When using
  2858.      the `CONSTRUCTORS' command, use `SORT_BY_NAME(CONSTRUCTORS)'
  2859.      instead.  When using the `.ctors' and `.dtors' sections, use
  2860.      `*(SORT_BY_NAME(.ctors))' and `*(SORT_BY_NAME(.dtors))' instead of
  2861.      just `*(.ctors)' and `*(.dtors)'.
  2862.  
  2863.      Normally the compiler and linker will handle these issues
  2864.      automatically, and you will not need to concern yourself with
  2865.      them.  However, you may need to consider this if you are using C++
  2866.      and writing your own linker scripts.
  2867.  
  2868.  
  2869. 
  2870. File: ld.info,  Node: Output Section Discarding,  Next: Output Section Attributes,  Prev: Output Section Keywords,  Up: SECTIONS
  2871.  
  2872. 3.6.7 Output Section Discarding
  2873. -------------------------------
  2874.  
  2875. The linker will not create output section which do not have any
  2876. contents.  This is for convenience when referring to input sections that
  2877. may or may not be present in any of the input files.  For example:
  2878.      .foo { *(.foo) }
  2879.    will only create a `.foo' section in the output file if there is a
  2880. `.foo' section in at least one input file.
  2881.  
  2882.    If you use anything other than an input section description as an
  2883. output section command, such as a symbol assignment, then the output
  2884. section will always be created, even if there are no matching input
  2885. sections.
  2886.  
  2887.    The special output section name `/DISCARD/' may be used to discard
  2888. input sections.  Any input sections which are assigned to an output
  2889. section named `/DISCARD/' are not included in the output file.
  2890.  
  2891. 
  2892. File: ld.info,  Node: Output Section Attributes,  Next: Overlay Description,  Prev: Output Section Discarding,  Up: SECTIONS
  2893.  
  2894. 3.6.8 Output Section Attributes
  2895. -------------------------------
  2896.  
  2897. We showed above that the full description of an output section looked
  2898. like this:
  2899.      SECTION [ADDRESS] [(TYPE)] :
  2900.        [AT(LMA)] [SUBALIGN(SUBSECTION_ALIGN)]
  2901.        {
  2902.          OUTPUT-SECTION-COMMAND
  2903.          OUTPUT-SECTION-COMMAND
  2904.          ...
  2905.        } [>REGION] [AT>LMA_REGION] [:PHDR :PHDR ...] [=FILLEXP]
  2906. We've already described SECTION, ADDRESS, and
  2907. OUTPUT-SECTION-COMMAND.  In this section we will describe the remaining
  2908. section attributes.
  2909.  
  2910. * Menu:
  2911.  
  2912. * Output Section Type::        Output section type
  2913. * Output Section LMA::        Output section LMA
  2914. * Forced Input Alignment::    Forced Input Alignment
  2915. * Output Section Region::    Output section region
  2916. * Output Section Phdr::        Output section phdr
  2917. * Output Section Fill::        Output section fill
  2918.  
  2919. 
  2920. File: ld.info,  Node: Output Section Type,  Next: Output Section LMA,  Up: Output Section Attributes
  2921.  
  2922. 3.6.8.1 Output Section Type
  2923. ...........................
  2924.  
  2925. Each output section may have a type.  The type is a keyword in
  2926. parentheses.  The following types are defined:
  2927.  
  2928. `NOLOAD'
  2929.      The section should be marked as not loadable, so that it will not
  2930.      be loaded into memory when the program is run.
  2931.  
  2932. `DSECT'
  2933. `COPY'
  2934. `INFO'
  2935. `OVERLAY'
  2936.      These type names are supported for backward compatibility, and are
  2937.      rarely used.  They all have the same effect: the section should be
  2938.      marked as not allocatable, so that no memory is allocated for the
  2939.      section when the program is run.
  2940.  
  2941.    The linker normally sets the attributes of an output section based on
  2942. the input sections which map into it.  You can override this by using
  2943. the section type.  For example, in the script sample below, the `ROM'
  2944. section is addressed at memory location `0' and does not need to be
  2945. loaded when the program is run.  The contents of the `ROM' section will
  2946. appear in the linker output file as usual.
  2947.      SECTIONS {
  2948.        ROM 0 (NOLOAD) : { ... }
  2949.        ...
  2950.      }
  2951.  
  2952. 
  2953. File: ld.info,  Node: Output Section LMA,  Next: Forced Input Alignment,  Prev: Output Section Type,  Up: Output Section Attributes
  2954.  
  2955. 3.6.8.2 Output Section LMA
  2956. ..........................
  2957.  
  2958. Every section has a virtual address (VMA) and a load address (LMA); see
  2959. *Note Basic Script Concepts::.  The address expression which may appear
  2960. in an output section description sets the VMA (*note Output Section
  2961. Address::).
  2962.  
  2963.    The linker will normally set the LMA equal to the VMA.  You can
  2964. change that by using the `AT' keyword.  The expression LMA that follows
  2965. the `AT' keyword specifies the load address of the section.
  2966.  
  2967.    Alternatively, with `AT>LMA_REGION' expression, you may specify a
  2968. memory region for the section's load address. *Note MEMORY::.  Note
  2969. that if the section has not had a VMA assigned to it then the linker
  2970. will use the LMA_REGION as the VMA region as well.  *Note Output
  2971. Section Region::.
  2972.  
  2973.    This feature is designed to make it easy to build a ROM image.  For
  2974. example, the following linker script creates three output sections: one
  2975. called `.text', which starts at `0x1000', one called `.mdata', which is
  2976. loaded at the end of the `.text' section even though its VMA is
  2977. `0x2000', and one called `.bss' to hold uninitialized data at address
  2978. `0x3000'.  The symbol `_data' is defined with the value `0x2000', which
  2979. shows that the location counter holds the VMA value, not the LMA value.
  2980.  
  2981.      SECTIONS
  2982.        {
  2983.        .text 0x1000 : { *(.text) _etext = . ; }
  2984.        .mdata 0x2000 :
  2985.          AT ( ADDR (.text) + SIZEOF (.text) )
  2986.          { _data = . ; *(.data); _edata = . ;  }
  2987.        .bss 0x3000 :
  2988.          { _bstart = . ;  *(.bss) *(COMMON) ; _bend = . ;}
  2989.      }
  2990.  
  2991.    The run-time initialization code for use with a program generated
  2992. with this linker script would include something like the following, to
  2993. copy the initialized data from the ROM image to its runtime address.
  2994. Notice how this code takes advantage of the symbols defined by the
  2995. linker script.
  2996.  
  2997.      extern char _etext, _data, _edata, _bstart, _bend;
  2998.      char *src = &_etext;
  2999.      char *dst = &_data;
  3000.  
  3001.      /* ROM has data at end of text; copy it. */
  3002.      while (dst < &_edata) {
  3003.        *dst++ = *src++;
  3004.      }
  3005.  
  3006.      /* Zero bss */
  3007.      for (dst = &_bstart; dst< &_bend; dst++)
  3008.        *dst = 0;
  3009.  
  3010. 
  3011. File: ld.info,  Node: Forced Input Alignment,  Next: Output Section Region,  Prev: Output Section LMA,  Up: Output Section Attributes
  3012.  
  3013. 3.6.8.3 Forced Input Alignment
  3014. ..............................
  3015.  
  3016. You can force input section alignment within an output section by using
  3017. SUBALIGN.  The value specified overrides any alignment given by input
  3018. sections, whether larger or smaller.
  3019.  
  3020. 
  3021. File: ld.info,  Node: Output Section Region,  Next: Output Section Phdr,  Prev: Forced Input Alignment,  Up: Output Section Attributes
  3022.  
  3023. 3.6.8.4 Output Section Region
  3024. .............................
  3025.  
  3026. You can assign a section to a previously defined region of memory by
  3027. using `>REGION'.  *Note MEMORY::.
  3028.  
  3029.    Here is a simple example:
  3030.      MEMORY { rom : ORIGIN = 0x1000, LENGTH = 0x1000 }
  3031.      SECTIONS { ROM : { *(.text) } >rom }
  3032.  
  3033. 
  3034. File: ld.info,  Node: Output Section Phdr,  Next: Output Section Fill,  Prev: Output Section Region,  Up: Output Section Attributes
  3035.  
  3036. 3.6.8.5 Output Section Phdr
  3037. ...........................
  3038.  
  3039. You can assign a section to a previously defined program segment by
  3040. using `:PHDR'.  *Note PHDRS::.  If a section is assigned to one or more
  3041. segments, then all subsequent allocated sections will be assigned to
  3042. those segments as well, unless they use an explicitly `:PHDR' modifier.
  3043. You can use `:NONE' to tell the linker to not put the section in any
  3044. segment at all.
  3045.  
  3046.    Here is a simple example:
  3047.      PHDRS { text PT_LOAD ; }
  3048.      SECTIONS { .text : { *(.text) } :text }
  3049.  
  3050. 
  3051. File: ld.info,  Node: Output Section Fill,  Prev: Output Section Phdr,  Up: Output Section Attributes
  3052.  
  3053. 3.6.8.6 Output Section Fill
  3054. ...........................
  3055.  
  3056. You can set the fill pattern for an entire section by using `=FILLEXP'.
  3057. FILLEXP is an expression (*note Expressions::).  Any otherwise
  3058. unspecified regions of memory within the output section (for example,
  3059. gaps left due to the required alignment of input sections) will be
  3060. filled with the value, repeated as necessary.  If the fill expression
  3061. is a simple hex number, ie. a string of hex digit starting with `0x'
  3062. and without a trailing `k' or `M', then an arbitrarily long sequence of
  3063. hex digits can be used to specify the fill pattern;  Leading zeros
  3064. become part of the pattern too.  For all other cases, including extra
  3065. parentheses or a unary `+', the fill pattern is the four least
  3066. significant bytes of the value of the expression.  In all cases, the
  3067. number is big-endian.
  3068.  
  3069.    You can also change the fill value with a `FILL' command in the
  3070. output section commands; (*note Output Section Data::).
  3071.  
  3072.    Here is a simple example:
  3073.      SECTIONS { .text : { *(.text) } =0x90909090 }
  3074.  
  3075. 
  3076. File: ld.info,  Node: Overlay Description,  Prev: Output Section Attributes,  Up: SECTIONS
  3077.  
  3078. 3.6.9 Overlay Description
  3079. -------------------------
  3080.  
  3081. An overlay description provides an easy way to describe sections which
  3082. are to be loaded as part of a single memory image but are to be run at
  3083. the same memory address.  At run time, some sort of overlay manager will
  3084. copy the overlaid sections in and out of the runtime memory address as
  3085. required, perhaps by simply manipulating addressing bits.  This approach
  3086. can be useful, for example, when a certain region of memory is faster
  3087. than another.
  3088.  
  3089.    Overlays are described using the `OVERLAY' command.  The `OVERLAY'
  3090. command is used within a `SECTIONS' command, like an output section
  3091. description.  The full syntax of the `OVERLAY' command is as follows:
  3092.      OVERLAY [START] : [NOCROSSREFS] [AT ( LDADDR )]
  3093.        {
  3094.          SECNAME1
  3095.            {
  3096.              OUTPUT-SECTION-COMMAND
  3097.              OUTPUT-SECTION-COMMAND
  3098.              ...
  3099.            } [:PHDR...] [=FILL]
  3100.          SECNAME2
  3101.            {
  3102.              OUTPUT-SECTION-COMMAND
  3103.              OUTPUT-SECTION-COMMAND
  3104.              ...
  3105.            } [:PHDR...] [=FILL]
  3106.          ...
  3107.        } [>REGION] [:PHDR...] [=FILL]
  3108.  
  3109.    Everything is optional except `OVERLAY' (a keyword), and each
  3110. section must have a name (SECNAME1 and SECNAME2 above).  The section
  3111. definitions within the `OVERLAY' construct are identical to those
  3112. within the general `SECTIONS' contruct (*note SECTIONS::), except that
  3113. no addresses and no memory regions may be defined for sections within
  3114. an `OVERLAY'.
  3115.  
  3116.    The sections are all defined with the same starting address.  The
  3117. load addresses of the sections are arranged such that they are
  3118. consecutive in memory starting at the load address used for the
  3119. `OVERLAY' as a whole (as with normal section definitions, the load
  3120. address is optional, and defaults to the start address; the start
  3121. address is also optional, and defaults to the current value of the
  3122. location counter).
  3123.  
  3124.    If the `NOCROSSREFS' keyword is used, and there any references among
  3125. the sections, the linker will report an error.  Since the sections all
  3126. run at the same address, it normally does not make sense for one
  3127. section to refer directly to another.  *Note NOCROSSREFS: Miscellaneous
  3128. Commands.
  3129.  
  3130.    For each section within the `OVERLAY', the linker automatically
  3131. defines two symbols.  The symbol `__load_start_SECNAME' is defined as
  3132. the starting load address of the section.  The symbol
  3133. `__load_stop_SECNAME' is defined as the final load address of the
  3134. section.  Any characters within SECNAME which are not legal within C
  3135. identifiers are removed.  C (or assembler) code may use these symbols
  3136. to move the overlaid sections around as necessary.
  3137.  
  3138.    At the end of the overlay, the value of the location counter is set
  3139. to the start address of the overlay plus the size of the largest
  3140. section.
  3141.  
  3142.    Here is an example.  Remember that this would appear inside a
  3143. `SECTIONS' construct.
  3144.        OVERLAY 0x1000 : AT (0x4000)
  3145.         {
  3146.           .text0 { o1/*.o(.text) }
  3147.           .text1 { o2/*.o(.text) }
  3148.         }
  3149. This will define both `.text0' and `.text1' to start at address
  3150. 0x1000.  `.text0' will be loaded at address 0x4000, and `.text1' will
  3151. be loaded immediately after `.text0'.  The following symbols will be
  3152. defined: `__load_start_text0', `__load_stop_text0',
  3153. `__load_start_text1', `__load_stop_text1'.
  3154.  
  3155.    C code to copy overlay `.text1' into the overlay area might look
  3156. like the following.
  3157.  
  3158.        extern char __load_start_text1, __load_stop_text1;
  3159.        memcpy ((char *) 0x1000, &__load_start_text1,
  3160.                &__load_stop_text1 - &__load_start_text1);
  3161.  
  3162.    Note that the `OVERLAY' command is just syntactic sugar, since
  3163. everything it does can be done using the more basic commands.  The above
  3164. example could have been written identically as follows.
  3165.  
  3166.        .text0 0x1000 : AT (0x4000) { o1/*.o(.text) }
  3167.        __load_start_text0 = LOADADDR (.text0);
  3168.        __load_stop_text0 = LOADADDR (.text0) + SIZEOF (.text0);
  3169.        .text1 0x1000 : AT (0x4000 + SIZEOF (.text0)) { o2/*.o(.text) }
  3170.        __load_start_text1 = LOADADDR (.text1);
  3171.        __load_stop_text1 = LOADADDR (.text1) + SIZEOF (.text1);
  3172.        . = 0x1000 + MAX (SIZEOF (.text0), SIZEOF (.text1));
  3173.  
  3174. 
  3175. File: ld.info,  Node: MEMORY,  Next: PHDRS,  Prev: SECTIONS,  Up: Scripts
  3176.  
  3177. 3.7 MEMORY Command
  3178. ==================
  3179.  
  3180. The linker's default configuration permits allocation of all available
  3181. memory.  You can override this by using the `MEMORY' command.
  3182.  
  3183.    The `MEMORY' command describes the location and size of blocks of
  3184. memory in the target.  You can use it to describe which memory regions
  3185. may be used by the linker, and which memory regions it must avoid.  You
  3186. can then assign sections to particular memory regions.  The linker will
  3187. set section addresses based on the memory regions, and will warn about
  3188. regions that become too full.  The linker will not shuffle sections
  3189. around to fit into the available regions.
  3190.  
  3191.    A linker script may contain at most one use of the `MEMORY' command.
  3192. However, you can define as many blocks of memory within it as you
  3193. wish.  The syntax is:
  3194.      MEMORY
  3195.        {
  3196.          NAME [(ATTR)] : ORIGIN = ORIGIN, LENGTH = LEN
  3197.          ...
  3198.        }
  3199.  
  3200.    The NAME is a name used in the linker script to refer to the region.
  3201. The region name has no meaning outside of the linker script.  Region
  3202. names are stored in a separate name space, and will not conflict with
  3203. symbol names, file names, or section names.  Each memory region must
  3204. have a distinct name.
  3205.  
  3206.    The ATTR string is an optional list of attributes that specify
  3207. whether to use a particular memory region for an input section which is
  3208. not explicitly mapped in the linker script.  As described in *Note
  3209. SECTIONS::, if you do not specify an output section for some input
  3210. section, the linker will create an output section with the same name as
  3211. the input section.  If you define region attributes, the linker will use
  3212. them to select the memory region for the output section that it creates.
  3213.  
  3214.    The ATTR string must consist only of the following characters:
  3215. `R'
  3216.      Read-only section
  3217.  
  3218. `W'
  3219.      Read/write section
  3220.  
  3221. `X'
  3222.      Executable section
  3223.  
  3224. `A'
  3225.      Allocatable section
  3226.  
  3227. `I'
  3228.      Initialized section
  3229.  
  3230. `L'
  3231.      Same as `I'
  3232.  
  3233. `!'
  3234.      Invert the sense of any of the preceding attributes
  3235.  
  3236.    If a unmapped section matches any of the listed attributes other than
  3237. `!', it will be placed in the memory region.  The `!' attribute
  3238. reverses this test, so that an unmapped section will be placed in the
  3239. memory region only if it does not match any of the listed attributes.
  3240.  
  3241.    The ORIGIN is an numerical expression for the start address of the
  3242. memory region.  The expression must evaluate to a constant and it
  3243. cannot involve any symbols.  The keyword `ORIGIN' may be abbreviated to
  3244. `org' or `o' (but not, for example, `ORG').
  3245.  
  3246.    The LEN is an expression for the size in bytes of the memory region.
  3247. As with the ORIGIN expression, the expression must be numerical only
  3248. and must evaluate to a constant.  The keyword `LENGTH' may be
  3249. abbreviated to `len' or `l'.
  3250.  
  3251.    In the following example, we specify that there are two memory
  3252. regions available for allocation: one starting at `0' for 256 kilobytes,
  3253. and the other starting at `0x40000000' for four megabytes.  The linker
  3254. will place into the `rom' memory region every section which is not
  3255. explicitly mapped into a memory region, and is either read-only or
  3256. executable.  The linker will place other sections which are not
  3257. explicitly mapped into a memory region into the `ram' memory region.
  3258.  
  3259.      MEMORY
  3260.        {
  3261.          rom (rx)  : ORIGIN = 0, LENGTH = 256K
  3262.          ram (!rx) : org = 0x40000000, l = 4M
  3263.        }
  3264.  
  3265.    Once you define a memory region, you can direct the linker to place
  3266. specific output sections into that memory region by using the `>REGION'
  3267. output section attribute.  For example, if you have a memory region
  3268. named `mem', you would use `>mem' in the output section definition.
  3269. *Note Output Section Region::.  If no address was specified for the
  3270. output section, the linker will set the address to the next available
  3271. address within the memory region.  If the combined output sections
  3272. directed to a memory region are too large for the region, the linker
  3273. will issue an error message.
  3274.  
  3275.    It is possible to access the origin and length of a memory in an
  3276. expression via the `ORIGIN(MEMORY)' and `LENGTH(MEMORY)' functions:
  3277.  
  3278.        _fstack = ORIGIN(ram) + LENGTH(ram) - 4;
  3279.  
  3280. 
  3281. File: ld.info,  Node: PHDRS,  Next: VERSION,  Prev: MEMORY,  Up: Scripts
  3282.  
  3283. 3.8 PHDRS Command
  3284. =================
  3285.  
  3286. The ELF object file format uses "program headers", also knows as
  3287. "segments".  The program headers describe how the program should be
  3288. loaded into memory.  You can print them out by using the `objdump'
  3289. program with the `-p' option.
  3290.  
  3291.    When you run an ELF program on a native ELF system, the system loader
  3292. reads the program headers in order to figure out how to load the
  3293. program.  This will only work if the program headers are set correctly.
  3294. This manual does not describe the details of how the system loader
  3295. interprets program headers; for more information, see the ELF ABI.
  3296.  
  3297.    The linker will create reasonable program headers by default.
  3298. However, in some cases, you may need to specify the program headers more
  3299. precisely.  You may use the `PHDRS' command for this purpose.  When the
  3300. linker sees the `PHDRS' command in the linker script, it will not
  3301. create any program headers other than the ones specified.
  3302.  
  3303.    The linker only pays attention to the `PHDRS' command when
  3304. generating an ELF output file.  In other cases, the linker will simply
  3305. ignore `PHDRS'.
  3306.  
  3307.    This is the syntax of the `PHDRS' command.  The words `PHDRS',
  3308. `FILEHDR', `AT', and `FLAGS' are keywords.
  3309.  
  3310.      PHDRS
  3311.      {
  3312.        NAME TYPE [ FILEHDR ] [ PHDRS ] [ AT ( ADDRESS ) ]
  3313.              [ FLAGS ( FLAGS ) ] ;
  3314.      }
  3315.  
  3316.    The NAME is used only for reference in the `SECTIONS' command of the
  3317. linker script.  It is not put into the output file.  Program header
  3318. names are stored in a separate name space, and will not conflict with
  3319. symbol names, file names, or section names.  Each program header must
  3320. have a distinct name.
  3321.  
  3322.    Certain program header types describe segments of memory which the
  3323. system loader will load from the file.  In the linker script, you
  3324. specify the contents of these segments by placing allocatable output
  3325. sections in the segments.  You use the `:PHDR' output section attribute
  3326. to place a section in a particular segment.  *Note Output Section
  3327. Phdr::.
  3328.  
  3329.    It is normal to put certain sections in more than one segment.  This
  3330. merely implies that one segment of memory contains another.  You may
  3331. repeat `:PHDR', using it once for each segment which should contain the
  3332. section.
  3333.  
  3334.    If you place a section in one or more segments using `:PHDR', then
  3335. the linker will place all subsequent allocatable sections which do not
  3336. specify `:PHDR' in the same segments.  This is for convenience, since
  3337. generally a whole set of contiguous sections will be placed in a single
  3338. segment.  You can use `:NONE' to override the default segment and tell
  3339. the linker to not put the section in any segment at all.
  3340.  
  3341.    You may use the `FILEHDR' and `PHDRS' keywords appear after the
  3342. program header type to further describe the contents of the segment.
  3343. The `FILEHDR' keyword means that the segment should include the ELF
  3344. file header.  The `PHDRS' keyword means that the segment should include
  3345. the ELF program headers themselves.
  3346.  
  3347.    The TYPE may be one of the following.  The numbers indicate the
  3348. value of the keyword.
  3349.  
  3350. `PT_NULL' (0)
  3351.      Indicates an unused program header.
  3352.  
  3353. `PT_LOAD' (1)
  3354.      Indicates that this program header describes a segment to be
  3355.      loaded from the file.
  3356.  
  3357. `PT_DYNAMIC' (2)
  3358.      Indicates a segment where dynamic linking information can be found.
  3359.  
  3360. `PT_INTERP' (3)
  3361.      Indicates a segment where the name of the program interpreter may
  3362.      be found.
  3363.  
  3364. `PT_NOTE' (4)
  3365.      Indicates a segment holding note information.
  3366.  
  3367. `PT_SHLIB' (5)
  3368.      A reserved program header type, defined but not specified by the
  3369.      ELF ABI.
  3370.  
  3371. `PT_PHDR' (6)
  3372.      Indicates a segment where the program headers may be found.
  3373.  
  3374. EXPRESSION
  3375.      An expression giving the numeric type of the program header.  This
  3376.      may be used for types not defined above.
  3377.  
  3378.    You can specify that a segment should be loaded at a particular
  3379. address in memory by using an `AT' expression.  This is identical to the
  3380. `AT' command used as an output section attribute (*note Output Section
  3381. LMA::).  The `AT' command for a program header overrides the output
  3382. section attribute.
  3383.  
  3384.    The linker will normally set the segment flags based on the sections
  3385. which comprise the segment.  You may use the `FLAGS' keyword to
  3386. explicitly specify the segment flags.  The value of FLAGS must be an
  3387. integer.  It is used to set the `p_flags' field of the program header.
  3388.  
  3389.    Here is an example of `PHDRS'.  This shows a typical set of program
  3390. headers used on a native ELF system.
  3391.  
  3392.      PHDRS
  3393.      {
  3394.        headers PT_PHDR PHDRS ;
  3395.        interp PT_INTERP ;
  3396.        text PT_LOAD FILEHDR PHDRS ;
  3397.        data PT_LOAD ;
  3398.        dynamic PT_DYNAMIC ;
  3399.      }
  3400.  
  3401.      SECTIONS
  3402.      {
  3403.        . = SIZEOF_HEADERS;
  3404.        .interp : { *(.interp) } :text :interp
  3405.        .text : { *(.text) } :text
  3406.        .rodata : { *(.rodata) } /* defaults to :text */
  3407.        ...
  3408.        . = . + 0x1000; /* move to a new page in memory */
  3409.        .data : { *(.data) } :data
  3410.        .dynamic : { *(.dynamic) } :data :dynamic
  3411.        ...
  3412.      }
  3413.  
  3414. 
  3415. File: ld.info,  Node: VERSION,  Next: Expressions,  Prev: PHDRS,  Up: Scripts
  3416.  
  3417. 3.9 VERSION Command
  3418. ===================
  3419.  
  3420. The linker supports symbol versions when using ELF.  Symbol versions are
  3421. only useful when using shared libraries.  The dynamic linker can use
  3422. symbol versions to select a specific version of a function when it runs
  3423. a program that may have been linked against an earlier version of the
  3424. shared library.
  3425.  
  3426.    You can include a version script directly in the main linker script,
  3427. or you can supply the version script as an implicit linker script.  You
  3428. can also use the `--version-script' linker option.
  3429.  
  3430.    The syntax of the `VERSION' command is simply
  3431.      VERSION { version-script-commands }
  3432.  
  3433.    The format of the version script commands is identical to that used
  3434. by Sun's linker in Solaris 2.5.  The version script defines a tree of
  3435. version nodes.  You specify the node names and interdependencies in the
  3436. version script.  You can specify which symbols are bound to which
  3437. version nodes, and you can reduce a specified set of symbols to local
  3438. scope so that they are not globally visible outside of the shared
  3439. library.
  3440.  
  3441.    The easiest way to demonstrate the version script language is with a
  3442. few examples.
  3443.  
  3444.      VERS_1.1 {
  3445.           global:
  3446.               foo1;
  3447.           local:
  3448.               old*;
  3449.               original*;
  3450.               new*;
  3451.      };
  3452.  
  3453.      VERS_1.2 {
  3454.               foo2;
  3455.      } VERS_1.1;
  3456.  
  3457.      VERS_2.0 {
  3458.               bar1; bar2;
  3459.      } VERS_1.2;
  3460.  
  3461.    This example version script defines three version nodes.  The first
  3462. version node defined is `VERS_1.1'; it has no other dependencies.  The
  3463. script binds the symbol `foo1' to `VERS_1.1'.  It reduces a number of
  3464. symbols to local scope so that they are not visible outside of the
  3465. shared library; this is done using wildcard patterns, so that any
  3466. symbol whose name begins with `old', `original', or `new' is matched.
  3467. The wildcard patterns available are the same as those used in the shell
  3468. when matching filenames (also known as "globbing").
  3469.  
  3470.    Next, the version script defines node `VERS_1.2'.  This node depends
  3471. upon `VERS_1.1'.  The script binds the symbol `foo2' to the version
  3472. node `VERS_1.2'.
  3473.  
  3474.    Finally, the version script defines node `VERS_2.0'.  This node
  3475. depends upon `VERS_1.2'.  The scripts binds the symbols `bar1' and
  3476. `bar2' are bound to the version node `VERS_2.0'.
  3477.  
  3478.    When the linker finds a symbol defined in a library which is not
  3479. specifically bound to a version node, it will effectively bind it to an
  3480. unspecified base version of the library.  You can bind all otherwise
  3481. unspecified symbols to a given version node by using `global: *;'
  3482. somewhere in the version script.
  3483.  
  3484.    The names of the version nodes have no specific meaning other than
  3485. what they might suggest to the person reading them.  The `2.0' version
  3486. could just as well have appeared in between `1.1' and `1.2'.  However,
  3487. this would be a confusing way to write a version script.
  3488.  
  3489.    Node name can be omited, provided it is the only version node in the
  3490. version script.  Such version script doesn't assign any versions to
  3491. symbols, only selects which symbols will be globally visible out and
  3492. which won't.
  3493.  
  3494.      { global: foo; bar; local: *; };
  3495.  
  3496.    When you link an application against a shared library that has
  3497. versioned symbols, the application itself knows which version of each
  3498. symbol it requires, and it also knows which version nodes it needs from
  3499. each shared library it is linked against.  Thus at runtime, the dynamic
  3500. loader can make a quick check to make sure that the libraries you have
  3501. linked against do in fact supply all of the version nodes that the
  3502. application will need to resolve all of the dynamic symbols.  In this
  3503. way it is possible for the dynamic linker to know with certainty that
  3504. all external symbols that it needs will be resolvable without having to
  3505. search for each symbol reference.
  3506.  
  3507.    The symbol versioning is in effect a much more sophisticated way of
  3508. doing minor version checking that SunOS does.  The fundamental problem
  3509. that is being addressed here is that typically references to external
  3510. functions are bound on an as-needed basis, and are not all bound when
  3511. the application starts up.  If a shared library is out of date, a
  3512. required interface may be missing; when the application tries to use
  3513. that interface, it may suddenly and unexpectedly fail.  With symbol
  3514. versioning, the user will get a warning when they start their program if
  3515. the libraries being used with the application are too old.
  3516.  
  3517.    There are several GNU extensions to Sun's versioning approach.  The
  3518. first of these is the ability to bind a symbol to a version node in the
  3519. source file where the symbol is defined instead of in the versioning
  3520. script.  This was done mainly to reduce the burden on the library
  3521. maintainer.  You can do this by putting something like:
  3522.      __asm__(".symver original_foo,foo@VERS_1.1");
  3523.    in the C source file.  This renames the function `original_foo' to
  3524. be an alias for `foo' bound to the version node `VERS_1.1'.  The
  3525. `local:' directive can be used to prevent the symbol `original_foo'
  3526. from being exported. A `.symver' directive takes precedence over a
  3527. version script.
  3528.  
  3529.    The second GNU extension is to allow multiple versions of the same
  3530. function to appear in a given shared library.  In this way you can make
  3531. an incompatible change to an interface without increasing the major
  3532. version number of the shared library, while still allowing applications
  3533. linked against the old interface to continue to function.
  3534.  
  3535.    To do this, you must use multiple `.symver' directives in the source
  3536. file.  Here is an example:
  3537.  
  3538.      __asm__(".symver original_foo,foo@");
  3539.      __asm__(".symver old_foo,foo@VERS_1.1");
  3540.      __asm__(".symver old_foo1,foo@VERS_1.2");
  3541.      __asm__(".symver new_foo,foo@@VERS_2.0");
  3542.  
  3543.    In this example, `foo@' represents the symbol `foo' bound to the
  3544. unspecified base version of the symbol.  The source file that contains
  3545. this example would define 4 C functions: `original_foo', `old_foo',
  3546. `old_foo1', and `new_foo'.
  3547.  
  3548.    When you have multiple definitions of a given symbol, there needs to
  3549. be some way to specify a default version to which external references to
  3550. this symbol will be bound.  You can do this with the `foo@@VERS_2.0'
  3551. type of `.symver' directive.  You can only declare one version of a
  3552. symbol as the default in this manner; otherwise you would effectively
  3553. have multiple definitions of the same symbol.
  3554.  
  3555.    If you wish to bind a reference to a specific version of the symbol
  3556. within the shared library, you can use the aliases of convenience
  3557. (i.e., `old_foo'), or you can use the `.symver' directive to
  3558. specifically bind to an external version of the function in question.
  3559.  
  3560.    You can also specify the language in the version script:
  3561.  
  3562.      VERSION extern "lang" { version-script-commands }
  3563.  
  3564.    The supported `lang's are `C', `C++', and `Java'.  The linker will
  3565. iterate over the list of symbols at the link time and demangle them
  3566. according to `lang' before matching them to the patterns specified in
  3567. `version-script-commands'.
  3568.  
  3569. 
  3570. File: ld.info,  Node: Expressions,  Next: Implicit Linker Scripts,  Prev: VERSION,  Up: Scripts
  3571.  
  3572. 3.10 Expressions in Linker Scripts
  3573. ==================================
  3574.  
  3575. The syntax for expressions in the linker script language is identical to
  3576. that of C expressions.  All expressions are evaluated as integers.  All
  3577. expressions are evaluated in the same size, which is 32 bits if both the
  3578. host and target are 32 bits, and is otherwise 64 bits.
  3579.  
  3580.    You can use and set symbol values in expressions.
  3581.  
  3582.    The linker defines several special purpose builtin functions for use
  3583. in expressions.
  3584.  
  3585. * Menu:
  3586.  
  3587. * Constants::            Constants
  3588. * Symbols::            Symbol Names
  3589. * Location Counter::        The Location Counter
  3590. * Operators::            Operators
  3591. * Evaluation::            Evaluation
  3592. * Expression Section::        The Section of an Expression
  3593. * Builtin Functions::        Builtin Functions
  3594.  
  3595. 
  3596. File: ld.info,  Node: Constants,  Next: Symbols,  Up: Expressions
  3597.  
  3598. 3.10.1 Constants
  3599. ----------------
  3600.  
  3601. All constants are integers.
  3602.  
  3603.    As in C, the linker considers an integer beginning with `0' to be
  3604. octal, and an integer beginning with `0x' or `0X' to be hexadecimal.
  3605. The linker considers other integers to be decimal.
  3606.  
  3607.    In addition, you can use the suffixes `K' and `M' to scale a
  3608. constant by `1024' or `1024*1024' respectively. For example, the
  3609. following all refer to the same quantity:
  3610.      _fourk_1 = 4K;
  3611.      _fourk_2 = 4096;
  3612.      _fourk_3 = 0x1000;
  3613.  
  3614. 
  3615. File: ld.info,  Node: Symbols,  Next: Location Counter,  Prev: Constants,  Up: Expressions
  3616.  
  3617. 3.10.2 Symbol Names
  3618. -------------------
  3619.  
  3620. Unless quoted, symbol names start with a letter, underscore, or period
  3621. and may include letters, digits, underscores, periods, and hyphens.
  3622. Unquoted symbol names must not conflict with any keywords.  You can
  3623. specify a symbol which contains odd characters or has the same name as a
  3624. keyword by surrounding the symbol name in double quotes:
  3625.      "SECTION" = 9;
  3626.      "with a space" = "also with a space" + 10;
  3627.  
  3628.    Since symbols can contain many non-alphabetic characters, it is
  3629. safest to delimit symbols with spaces.  For example, `A-B' is one
  3630. symbol, whereas `A - B' is an expression involving subtraction.
  3631.  
  3632. 
  3633. File: ld.info,  Node: Location Counter,  Next: Operators,  Prev: Symbols,  Up: Expressions
  3634.  
  3635. 3.10.3 The Location Counter
  3636. ---------------------------
  3637.  
  3638. The special linker variable "dot" `.' always contains the current
  3639. output location counter.  Since the `.' always refers to a location in
  3640. an output section, it may only appear in an expression within a
  3641. `SECTIONS' command.  The `.' symbol may appear anywhere that an
  3642. ordinary symbol is allowed in an expression.
  3643.  
  3644.    Assigning a value to `.' will cause the location counter to be
  3645. moved.  This may be used to create holes in the output section.  The
  3646. location counter may never be moved backwards.
  3647.  
  3648.      SECTIONS
  3649.      {
  3650.        output :
  3651.          {
  3652.            file1(.text)
  3653.            . = . + 1000;
  3654.            file2(.text)
  3655.            . += 1000;
  3656.            file3(.text)
  3657.          } = 0x12345678;
  3658.      }
  3659.    In the previous example, the `.text' section from `file1' is located
  3660. at the beginning of the output section `output'.  It is followed by a
  3661. 1000 byte gap.  Then the `.text' section from `file2' appears, also
  3662. with a 1000 byte gap following before the `.text' section from `file3'.
  3663. The notation `= 0x12345678' specifies what data to write in the gaps
  3664. (*note Output Section Fill::).
  3665.  
  3666.    Note: `.' actually refers to the byte offset from the start of the
  3667. current containing object.  Normally this is the `SECTIONS' statement,
  3668. whose start address is 0, hence `.' can be used as an absolute address.
  3669. If `.' is used inside a section description however, it refers to the
  3670. byte offset from the start of that section, not an absolute address.
  3671. Thus in a script like this:
  3672.  
  3673.      SECTIONS
  3674.      {
  3675.          . = 0x100
  3676.          .text: {
  3677.            *(.text)
  3678.            . = 0x200
  3679.          }
  3680.          . = 0x500
  3681.          .data: {
  3682.            *(.data)
  3683.            . += 0x600
  3684.          }
  3685.      }
  3686.  
  3687.    The `.text' section will be assigned a starting address of 0x100 and
  3688. a size of exactly 0x200 bytes, even if there is not enough data in the
  3689. `.text' input sections to fill this area.  (If there is too much data,
  3690. an error will be produced because this would be an attempt to move `.'
  3691. backwards).  The `.data' section will start at 0x500 and it will have
  3692. an extra 0x600 bytes worth of space after the end of the values from
  3693. the `.data' input sections and before the end of the `.data' output
  3694. section itself.
  3695.  
  3696.    Setting symbols to the value of the location counter outside of an
  3697. output section statement can result in unexpected values if the linker
  3698. needs to place orphan sections.  For example, given the following:
  3699.  
  3700.      SECTIONS
  3701.      {
  3702.          start_of_text = . ;
  3703.          .text: { *(.text) }
  3704.          end_of_text = . ;
  3705.  
  3706.          start_of_data = . ;
  3707.          .data: { *(.data) }
  3708.          end_of_data = . ;
  3709.      }
  3710.  
  3711.    If the linker needs to place some input section, e.g. `.rodata', not
  3712. mentioned in the script, it might choose to place that section between
  3713. `.text' and `.data'.  You might think the linker should place `.rodata'
  3714. on the blank line in the above script, but blank lines are of no
  3715. particular significance to the linker.  As well, the linker doesn't
  3716. associate the above symbol names with their sections.  Instead, it
  3717. assumes that all assignments or other statements belong to the previous
  3718. output section, except for the special case of an assignment to `.'.
  3719. I.e., the linker will place the orphan `.rodata' section as if the
  3720. script was written as follows:
  3721.  
  3722.      SECTIONS
  3723.      {
  3724.          start_of_text = . ;
  3725.          .text: { *(.text) }
  3726.          end_of_text = . ;
  3727.  
  3728.          start_of_data = . ;
  3729.          .rodata: { *(.rodata) }
  3730.          .data: { *(.data) }
  3731.          end_of_data = . ;
  3732.      }
  3733.  
  3734.    This may or may not be the script author's intention for the value of
  3735. `start_of_data'.  One way to influence the orphan section placement is
  3736. to assign the location counter to itself, as the linker assumes that an
  3737. assignment to `.' is setting the start address of a following output
  3738. section and thus should be grouped with that section.  So you could
  3739. write:
  3740.  
  3741.      SECTIONS
  3742.      {
  3743.          start_of_text = . ;
  3744.          .text: { *(.text) }
  3745.          end_of_text = . ;
  3746.  
  3747.          . = . ;
  3748.          start_of_data = . ;
  3749.          .data: { *(.data) }
  3750.          end_of_data = . ;
  3751.      }
  3752.  
  3753.    Now, the orphan `.rodata' section will be placed between
  3754. `end_of_text' and `start_of_data'.
  3755.  
  3756. 
  3757. File: ld.info,  Node: Operators,  Next: Evaluation,  Prev: Location Counter,  Up: Expressions
  3758.  
  3759. 3.10.4 Operators
  3760. ----------------
  3761.  
  3762. The linker recognizes the standard C set of arithmetic operators, with
  3763. the standard bindings and precedence levels:
  3764.      precedence      associativity   Operators                Notes
  3765.      (highest)
  3766.      1               left            !  -  ~                  (1)
  3767.      2               left            *  /  %
  3768.      3               left            +  -
  3769.      4               left            >>  <<
  3770.      5               left            ==  !=  >  <  <=  >=
  3771.      6               left            &
  3772.      7               left            |
  3773.      8               left            &&
  3774.      9               left            ||
  3775.      10              right           ? :
  3776.      11              right           &=  +=  -=  *=  /=       (2)
  3777.      (lowest)
  3778.    Notes: (1) Prefix operators (2) *Note Assignments::.
  3779.  
  3780. 
  3781. File: ld.info,  Node: Evaluation,  Next: Expression Section,  Prev: Operators,  Up: Expressions
  3782.  
  3783. 3.10.5 Evaluation
  3784. -----------------
  3785.  
  3786. The linker evaluates expressions lazily.  It only computes the value of
  3787. an expression when absolutely necessary.
  3788.  
  3789.    The linker needs some information, such as the value of the start
  3790. address of the first section, and the origins and lengths of memory
  3791. regions, in order to do any linking at all.  These values are computed
  3792. as soon as possible when the linker reads in the linker script.
  3793.  
  3794.    However, other values (such as symbol values) are not known or needed
  3795. until after storage allocation.  Such values are evaluated later, when
  3796. other information (such as the sizes of output sections) is available
  3797. for use in the symbol assignment expression.
  3798.  
  3799.    The sizes of sections cannot be known until after allocation, so
  3800. assignments dependent upon these are not performed until after
  3801. allocation.
  3802.  
  3803.    Some expressions, such as those depending upon the location counter
  3804. `.', must be evaluated during section allocation.
  3805.  
  3806.    If the result of an expression is required, but the value is not
  3807. available, then an error results.  For example, a script like the
  3808. following
  3809.      SECTIONS
  3810.        {
  3811.          .text 9+this_isnt_constant :
  3812.            { *(.text) }
  3813.        }
  3814. will cause the error message `non constant expression for initial
  3815. address'.
  3816.  
  3817. 
  3818. File: ld.info,  Node: Expression Section,  Next: Builtin Functions,  Prev: Evaluation,  Up: Expressions
  3819.  
  3820. 3.10.6 The Section of an Expression
  3821. -----------------------------------
  3822.  
  3823. When the linker evaluates an expression, the result is either absolute
  3824. or relative to some section.  A relative expression is expressed as a
  3825. fixed offset from the base of a section.
  3826.  
  3827.    The position of the expression within the linker script determines
  3828. whether it is absolute or relative.  An expression which appears within
  3829. an output section definition is relative to the base of the output
  3830. section.  An expression which appears elsewhere will be absolute.
  3831.  
  3832.    A symbol set to a relative expression will be relocatable if you
  3833. request relocatable output using the `-r' option.  That means that a
  3834. further link operation may change the value of the symbol.  The symbol's
  3835. section will be the section of the relative expression.
  3836.  
  3837.    A symbol set to an absolute expression will retain the same value
  3838. through any further link operation.  The symbol will be absolute, and
  3839. will not have any particular associated section.
  3840.  
  3841.    You can use the builtin function `ABSOLUTE' to force an expression
  3842. to be absolute when it would otherwise be relative.  For example, to
  3843. create an absolute symbol set to the address of the end of the output
  3844. section `.data':
  3845.      SECTIONS
  3846.        {
  3847.          .data : { *(.data) _edata = ABSOLUTE(.); }
  3848.        }
  3849.    If `ABSOLUTE' were not used, `_edata' would be relative to the
  3850. `.data' section.
  3851.  
  3852. 
  3853. File: ld.info,  Node: Builtin Functions,  Prev: Expression Section,  Up: Expressions
  3854.  
  3855. 3.10.7 Builtin Functions
  3856. ------------------------
  3857.  
  3858. The linker script language includes a number of builtin functions for
  3859. use in linker script expressions.
  3860.  
  3861. `ABSOLUTE(EXP)'
  3862.      Return the absolute (non-relocatable, as opposed to non-negative)
  3863.      value of the expression EXP.  Primarily useful to assign an
  3864.      absolute value to a symbol within a section definition, where
  3865.      symbol values are normally section relative.  *Note Expression
  3866.      Section::.
  3867.  
  3868. `ADDR(SECTION)'
  3869.      Return the absolute address (the VMA) of the named SECTION.  Your
  3870.      script must previously have defined the location of that section.
  3871.      In the following example, `symbol_1' and `symbol_2' are assigned
  3872.      identical values:
  3873.           SECTIONS { ...
  3874.             .output1 :
  3875.               {
  3876.               start_of_output_1 = ABSOLUTE(.);
  3877.               ...
  3878.               }
  3879.             .output :
  3880.               {
  3881.               symbol_1 = ADDR(.output1);
  3882.               symbol_2 = start_of_output_1;
  3883.               }
  3884.           ... }
  3885.  
  3886. `ALIGN(ALIGN)'
  3887. `ALIGN(EXP,ALIGN)'
  3888.      Return the location counter (`.') or arbitrary expression aligned
  3889.      to the next ALIGN boundary.  The single operand `ALIGN' doesn't
  3890.      change the value of the location counter--it just does arithmetic
  3891.      on it.  The two operand `ALIGN' allows an arbitrary expression to
  3892.      be aligned upwards (`ALIGN(ALIGN)' is equivalent to `ALIGN(.,
  3893.      ALIGN)').
  3894.  
  3895.      Here is an example which aligns the output `.data' section to the
  3896.      next `0x2000' byte boundary after the preceding section and sets a
  3897.      variable within the section to the next `0x8000' boundary after the
  3898.      input sections:
  3899.           SECTIONS { ...
  3900.             .data ALIGN(0x2000): {
  3901.               *(.data)
  3902.               variable = ALIGN(0x8000);
  3903.             }
  3904.           ... }
  3905.      The first use of `ALIGN' in this example specifies the
  3906.      location of a section because it is used as the optional ADDRESS
  3907.      attribute of a section definition (*note Output Section
  3908.      Address::).  The second use of `ALIGN' is used to defines the
  3909.      value of a symbol.
  3910.  
  3911.      The builtin function `NEXT' is closely related to `ALIGN'.
  3912.  
  3913. `BLOCK(EXP)'
  3914.      This is a synonym for `ALIGN', for compatibility with older linker
  3915.      scripts.  It is most often seen when setting the address of an
  3916.      output section.
  3917.  
  3918. `DATA_SEGMENT_ALIGN(MAXPAGESIZE, COMMONPAGESIZE)'
  3919.      This is equivalent to either
  3920.           (ALIGN(MAXPAGESIZE) + (. & (MAXPAGESIZE - 1)))
  3921.      or
  3922.           (ALIGN(MAXPAGESIZE) + (. & (MAXPAGESIZE - COMMONPAGESIZE)))
  3923.      depending on whether the latter uses fewer COMMONPAGESIZE sized
  3924.      pages for the data segment (area between the result of this
  3925.      expression and `DATA_SEGMENT_END') than the former or not.  If the
  3926.      latter form is used, it means COMMONPAGESIZE bytes of runtime
  3927.      memory will be saved at the expense of up to COMMONPAGESIZE wasted
  3928.      bytes in the on-disk file.
  3929.  
  3930.      This expression can only be used directly in `SECTIONS' commands,
  3931.      not in any output section descriptions and only once in the linker
  3932.      script.  COMMONPAGESIZE should be less or equal to MAXPAGESIZE and
  3933.      should be the system page size the object wants to be optimized
  3934.      for (while still working on system page sizes up to MAXPAGESIZE).
  3935.  
  3936.      Example:
  3937.             . = DATA_SEGMENT_ALIGN(0x10000, 0x2000);
  3938.  
  3939. `DATA_SEGMENT_END(EXP)'
  3940.      This defines the end of data segment for `DATA_SEGMENT_ALIGN'
  3941.      evaluation purposes.
  3942.  
  3943.             . = DATA_SEGMENT_END(.);
  3944.  
  3945. `DATA_SEGMENT_RELRO_END(OFFSET, EXP)'
  3946.      This defines the end of the `PT_GNU_RELRO' segment when `-z relro'
  3947.      option is used.  Second argument is returned.  When `-z relro'
  3948.      option is not present, `DATA_SEGMENT_RELRO_END' does nothing,
  3949.      otherwise `DATA_SEGMENT_ALIGN' is padded so that EXP + OFFSET is
  3950.      aligned to the most commonly used page boundary for particular
  3951.      target.  If present in the linker script, it must always come in
  3952.      between `DATA_SEGMENT_ALIGN' and `DATA_SEGMENT_END'.
  3953.  
  3954.             . = DATA_SEGMENT_RELRO_END(24, .);
  3955.  
  3956. `DEFINED(SYMBOL)'
  3957.      Return 1 if SYMBOL is in the linker global symbol table and is
  3958.      defined before the statement using DEFINED in the script, otherwise
  3959.      return 0.  You can use this function to provide default values for
  3960.      symbols.  For example, the following script fragment shows how to
  3961.      set a global symbol `begin' to the first location in the `.text'
  3962.      section--but if a symbol called `begin' already existed, its value
  3963.      is preserved:
  3964.  
  3965.           SECTIONS { ...
  3966.             .text : {
  3967.               begin = DEFINED(begin) ? begin : . ;
  3968.               ...
  3969.             }
  3970.             ...
  3971.           }
  3972.  
  3973. `LENGTH(MEMORY)'
  3974.      Return the length of the memory region named MEMORY.
  3975.  
  3976. `LOADADDR(SECTION)'
  3977.      Return the absolute LMA of the named SECTION.  This is normally
  3978.      the same as `ADDR', but it may be different if the `AT' attribute
  3979.      is used in the output section definition (*note Output Section
  3980.      LMA::).
  3981.  
  3982. `MAX(EXP1, EXP2)'
  3983.      Returns the maximum of EXP1 and EXP2.
  3984.  
  3985. `MIN(EXP1, EXP2)'
  3986.      Returns the minimum of EXP1 and EXP2.
  3987.  
  3988. `NEXT(EXP)'
  3989.      Return the next unallocated address that is a multiple of EXP.
  3990.      This function is closely related to `ALIGN(EXP)'; unless you use
  3991.      the `MEMORY' command to define discontinuous memory for the output
  3992.      file, the two functions are equivalent.
  3993.  
  3994. `ORIGIN(MEMORY)'
  3995.      Return the origin of the memory region named MEMORY.
  3996.  
  3997. `SEGMENT_START(SEGMENT, DEFAULT)'
  3998.      Return the base address of the named SEGMENT.  If an explicit
  3999.      value has been given for this segment (with a command-line `-T'
  4000.      option) that value will be returned; otherwise the value will be
  4001.      DEFAULT.  At present, the `-T' command-line option can only be
  4002.      used to set the base address for the "text", "data", and "bss"
  4003.      sections, but you use `SEGMENT_START' with any segment name.
  4004.  
  4005. `SIZEOF(SECTION)'
  4006.      Return the size in bytes of the named SECTION, if that section has
  4007.      been allocated.  If the section has not been allocated when this is
  4008.      evaluated, the linker will report an error.  In the following
  4009.      example, `symbol_1' and `symbol_2' are assigned identical values:
  4010.           SECTIONS{ ...
  4011.             .output {
  4012.               .start = . ;
  4013.               ...
  4014.               .end = . ;
  4015.               }
  4016.             symbol_1 = .end - .start ;
  4017.             symbol_2 = SIZEOF(.output);
  4018.           ... }
  4019.  
  4020. `SIZEOF_HEADERS'
  4021. `sizeof_headers'
  4022.      Return the size in bytes of the output file's headers.  This is
  4023.      information which appears at the start of the output file.  You
  4024.      can use this number when setting the start address of the first
  4025.      section, if you choose, to facilitate paging.
  4026.  
  4027.      When producing an ELF output file, if the linker script uses the
  4028.      `SIZEOF_HEADERS' builtin function, the linker must compute the
  4029.      number of program headers before it has determined all the section
  4030.      addresses and sizes.  If the linker later discovers that it needs
  4031.      additional program headers, it will report an error `not enough
  4032.      room for program headers'.  To avoid this error, you must avoid
  4033.      using the `SIZEOF_HEADERS' function, or you must rework your linker
  4034.      script to avoid forcing the linker to use additional program
  4035.      headers, or you must define the program headers yourself using the
  4036.      `PHDRS' command (*note PHDRS::).
  4037.  
  4038. 
  4039. File: ld.info,  Node: Implicit Linker Scripts,  Prev: Expressions,  Up: Scripts
  4040.  
  4041. 3.11 Implicit Linker Scripts
  4042. ============================
  4043.  
  4044. If you specify a linker input file which the linker can not recognize as
  4045. an object file or an archive file, it will try to read the file as a
  4046. linker script.  If the file can not be parsed as a linker script, the
  4047. linker will report an error.
  4048.  
  4049.    An implicit linker script will not replace the default linker script.
  4050.  
  4051.    Typically an implicit linker script would contain only symbol
  4052. assignments, or the `INPUT', `GROUP', or `VERSION' commands.
  4053.  
  4054.    Any input files read because of an implicit linker script will be
  4055. read at the position in the command line where the implicit linker
  4056. script was read.  This can affect archive searching.
  4057.  
  4058. 
  4059. File: ld.info,  Node: Machine Dependent,  Next: BFD,  Prev: Scripts,  Up: Top
  4060.  
  4061. 4 Machine Dependent Features
  4062. ****************************
  4063.  
  4064. `ld' has additional features on some platforms; the following sections
  4065. describe them.  Machines where `ld' has no additional functionality are
  4066. not listed.
  4067.  
  4068. * Menu:
  4069.  
  4070.  
  4071. * H8/300::                      `ld' and the H8/300
  4072.  
  4073. * i960::                        `ld' and the Intel 960 family
  4074.  
  4075. * ARM::                `ld' and the ARM family
  4076.  
  4077. * HPPA ELF32::                  `ld' and HPPA 32-bit ELF
  4078.  
  4079. * MMIX::            `ld' and MMIX
  4080.  
  4081. * MSP430::            `ld' and MSP430
  4082.  
  4083. * TI COFF::                     `ld' and TI COFF
  4084.  
  4085. * WIN32::                       `ld' and WIN32 (cygwin/mingw)
  4086.  
  4087. * Xtensa::                      `ld' and Xtensa Processors
  4088.  
  4089. 
  4090. File: ld.info,  Node: H8/300,  Next: i960,  Up: Machine Dependent
  4091.  
  4092. 4.1 `ld' and the H8/300
  4093. =======================
  4094.  
  4095. For the H8/300, `ld' can perform these global optimizations when you
  4096. specify the `--relax' command-line option.
  4097.  
  4098. _relaxing address modes_
  4099.      `ld' finds all `jsr' and `jmp' instructions whose targets are
  4100.      within eight bits, and turns them into eight-bit program-counter
  4101.      relative `bsr' and `bra' instructions, respectively.
  4102.  
  4103. _synthesizing instructions_
  4104.      `ld' finds all `mov.b' instructions which use the sixteen-bit
  4105.      absolute address form, but refer to the top page of memory, and
  4106.      changes them to use the eight-bit address form.  (That is: the
  4107.      linker turns `mov.b `@'AA:16' into `mov.b `@'AA:8' whenever the
  4108.      address AA is in the top page of memory).
  4109.  
  4110. _bit manipulation instructions_
  4111.      `ld' finds all bit manipulation instructions like `band, bclr,
  4112.      biand, bild, bior, bist, bixor, bld, bnot, bor, bset, bst, btst,
  4113.      bxor' which use 32 bit and 16 bit absolute address form, but refer
  4114.      to the top page of memory, and changes them to use the 8 bit
  4115.      address form.  (That is: the linker turns `bset #xx:3,`@'AA:32'
  4116.      into `bset #xx:3,`@'AA:8' whenever the address AA is in the top
  4117.      page of memory).
  4118.  
  4119. _system control instructions_
  4120.      `ld' finds all `ldc.w, stc.w' instrcutions which use the 32 bit
  4121.      absolute address form, but refer to the top page of memory, and
  4122.      changes them to use 16 bit address form.  (That is: the linker
  4123.      turns `ldc.w `@'AA:32,ccr' into `ldc.w `@'AA:16,ccr' whenever the
  4124.      address AA is in the top page of memory).
  4125.  
  4126. 
  4127. File: ld.info,  Node: i960,  Next: ARM,  Prev: H8/300,  Up: Machine Dependent
  4128.  
  4129. 4.2 `ld' and the Intel 960 Family
  4130. =================================
  4131.  
  4132. You can use the `-AARCHITECTURE' command line option to specify one of
  4133. the two-letter names identifying members of the 960 family; the option
  4134. specifies the desired output target, and warns of any incompatible
  4135. instructions in the input files.  It also modifies the linker's search
  4136. strategy for archive libraries, to support the use of libraries
  4137. specific to each particular architecture, by including in the search
  4138. loop names suffixed with the string identifying the architecture.
  4139.  
  4140.    For example, if your `ld' command line included `-ACA' as well as
  4141. `-ltry', the linker would look (in its built-in search paths, and in
  4142. any paths you specify with `-L') for a library with the names
  4143.  
  4144.      try
  4145.      libtry.a
  4146.      tryca
  4147.      libtryca.a
  4148.  
  4149. The first two possibilities would be considered in any event; the last
  4150. two are due to the use of `-ACA'.
  4151.  
  4152.    You can meaningfully use `-A' more than once on a command line, since
  4153. the 960 architecture family allows combination of target architectures;
  4154. each use will add another pair of name variants to search for when `-l'
  4155. specifies a library.
  4156.  
  4157.    `ld' supports the `--relax' option for the i960 family.  If you
  4158. specify `--relax', `ld' finds all `balx' and `calx' instructions whose
  4159. targets are within 24 bits, and turns them into 24-bit program-counter
  4160. relative `bal' and `cal' instructions, respectively.  `ld' also turns
  4161. `cal' instructions into `bal' instructions when it determines that the
  4162. target subroutine is a leaf routine (that is, the target subroutine does
  4163. not itself call any subroutines).
  4164.  
  4165. 
  4166. File: ld.info,  Node: ARM,  Next: HPPA ELF32,  Prev: i960,  Up: Machine Dependent
  4167.  
  4168. 4.3 `ld' and the ARM family
  4169. ===========================
  4170.  
  4171. For the ARM, `ld' will generate code stubs to allow functions calls
  4172. betweem ARM and Thumb code.  These stubs only work with code that has
  4173. been compiled and assembled with the `-mthumb-interwork' command line
  4174. option.  If it is necessary to link with old ARM object files or
  4175. libraries, which have not been compiled with the -mthumb-interwork
  4176. option then the `--support-old-code' command line switch should be
  4177. given to the linker.  This will make it generate larger stub functions
  4178. which will work with non-interworking aware ARM code.  Note, however,
  4179. the linker does not support generating stubs for function calls to
  4180. non-interworking aware Thumb code.
  4181.  
  4182.    The `--thumb-entry' switch is a duplicate of the generic `--entry'
  4183. switch, in that it sets the program's starting address.  But it also
  4184. sets the bottom bit of the address, so that it can be branched to using
  4185. a BX instruction, and the program will start executing in Thumb mode
  4186. straight away.
  4187.  
  4188.    The `--be8' switch instructs `ld' to generate BE8 format
  4189. executables.  This option is only valid when linking big-endian objects.
  4190. The resulting image will contain big-endian data and little-endian code.
  4191.  
  4192.    The `R_ARM_TARGET1' relocation is typically used for entries in the
  4193. `.init_array' section.  It is interpreted as either `R_ARM_REL32' or
  4194. `R_ARM_ABS32', depending on the target.  The `--target1-rel' and
  4195. `--target1-abs' switches override the default.
  4196.  
  4197.    The `--target2=type' switch overrides the default definition of the
  4198. `R_ARM_TARGET2' relocation.  Valid values for `type', their meanings,
  4199. and target defaults are as follows:
  4200. `rel'
  4201.      `R_ARM_REL32' (arm*-*-elf, arm*-*-eabi)
  4202.  
  4203. `abs'
  4204.      `R_ARM_ABS32' (arm*-*-symbianelf)
  4205.  
  4206. `got-rel'
  4207.      `R_ARM_GOT_PREL' (arm*-*-linux, arm*-*-*bsd)
  4208.  
  4209.    The `R_ARM_V4BX' relocation (defined by the ARM AAELF specification)
  4210. enables objects compiled for the ARMv4 architecture to be
  4211. interworking-safe when linked with other objects compiled for ARMv4t,
  4212. but also allows pure ARMv4 binaries to be built from the same ARMv4
  4213. objects.
  4214.  
  4215.    In the latter case, the switch `--fix-v4bx' must be passed to the
  4216. linker, which causes v4t `BX rM' instructions to be rewritten as `MOV
  4217. PC,rM', since v4 processors do not have a `BX' instruction.
  4218.  
  4219.    In the former case, the switch should not be used, and `R_ARM_V4BX'
  4220. relocations are ignored.
  4221.  
  4222. 
  4223. File: ld.info,  Node: HPPA ELF32,  Next: MMIX,  Prev: ARM,  Up: Machine Dependent
  4224.  
  4225. 4.4 `ld' and HPPA 32-bit ELF Support
  4226. ====================================
  4227.  
  4228. When generating a shared library, `ld' will by default generate import
  4229. stubs suitable for use with a single sub-space application.  The
  4230. `--multi-subspace' switch causes `ld' to generate export stubs, and
  4231. different (larger) import stubs suitable for use with multiple
  4232. sub-spaces.
  4233.  
  4234.    Long branch stubs and import/export stubs are placed by `ld' in stub
  4235. sections located between groups of input sections.  `--stub-group-size'
  4236. specifies the maximum size of a group of input sections handled by one
  4237. stub section.  Since branch offsets are signed, a stub section may
  4238. serve two groups of input sections, one group before the stub section,
  4239. and one group after it.  However, when using conditional branches that
  4240. require stubs, it may be better (for branch prediction) that stub
  4241. sections only serve one group of input sections.  A negative value for
  4242. `N' chooses this scheme, ensuring that branches to stubs always use a
  4243. negative offset.  Two special values of `N' are recognized, `1' and
  4244. `-1'.  These both instruct `ld' to automatically size input section
  4245. groups for the branch types detected, with the same behaviour regarding
  4246. stub placement as other positive or negative values of `N' respectively.
  4247.  
  4248.    Note that `--stub-group-size' does not split input sections.  A
  4249. single input section larger than the group size specified will of course
  4250. create a larger group (of one section).  If input sections are too
  4251. large, it may not be possible for a branch to reach its stub.
  4252.  
  4253. 
  4254. File: ld.info,  Node: MMIX,  Next: MSP430,  Prev: HPPA ELF32,  Up: Machine Dependent
  4255.  
  4256. 4.5 `ld' and MMIX
  4257. =================
  4258.  
  4259. For MMIX, there is a choice of generating `ELF' object files or `mmo'
  4260. object files when linking.  The simulator `mmix' understands the `mmo'
  4261. format.  The binutils `objcopy' utility can translate between the two
  4262. formats.
  4263.  
  4264.    There is one special section, the `.MMIX.reg_contents' section.
  4265. Contents in this section is assumed to correspond to that of global
  4266. registers, and symbols referring to it are translated to special
  4267. symbols, equal to registers.  In a final link, the start address of the
  4268. `.MMIX.reg_contents' section corresponds to the first allocated global
  4269. register multiplied by 8.  Register `$255' is not included in this
  4270. section; it is always set to the program entry, which is at the symbol
  4271. `Main' for `mmo' files.
  4272.  
  4273.    Symbols with the prefix `__.MMIX.start.', for example
  4274. `__.MMIX.start..text' and `__.MMIX.start..data' are special; there must
  4275. be only one each, even if they are local.  The default linker script
  4276. uses these to set the default start address of a section.
  4277.  
  4278.    Initial and trailing multiples of zero-valued 32-bit words in a
  4279. section, are left out from an mmo file.
  4280.  
  4281. 
  4282. File: ld.info,  Node: MSP430,  Next: TI COFF,  Prev: MMIX,  Up: Machine Dependent
  4283.  
  4284. 4.6 `ld' and MSP430
  4285. ===================
  4286.  
  4287. For the MSP430 it is possible to select the MPU architecture.  The flag
  4288. `-m [mpu type]' will select an appropriate linker script for selected
  4289. MPU type.  (To get a list of known MPUs just pass `-m help' option to
  4290. the linker).
  4291.  
  4292.    The linker will recognize some extra sections which are MSP430
  4293. specific:
  4294.  
  4295. ``.vectors''
  4296.      Defines a portion of ROM where interrupt vectors located.
  4297.  
  4298. ``.bootloader''
  4299.      Defines the bootloader portion of the ROM (if applicable).  Any
  4300.      code in this section will be uploaded to the MPU.
  4301.  
  4302. ``.infomem''
  4303.      Defines an information memory section (if applicable).  Any code in
  4304.      this section will be uploaded to the MPU.
  4305.  
  4306. ``.infomemnobits''
  4307.      This is the same as the `.infomem' section except that any code in
  4308.      this section will not be uploaded to the MPU.
  4309.  
  4310. ``.noinit''
  4311.      Denotes a portion of RAM located above `.bss' section.
  4312.  
  4313.      The last two sections are used by gcc.
  4314.  
  4315. 
  4316. File: ld.info,  Node: TI COFF,  Next: WIN32,  Prev: MSP430,  Up: Machine Dependent
  4317.  
  4318. 4.7 `ld''s Support for Various TI COFF Versions
  4319. ===============================================
  4320.  
  4321. The `--format' switch allows selection of one of the various TI COFF
  4322. versions.  The latest of this writing is 2; versions 0 and 1 are also
  4323. supported.  The TI COFF versions also vary in header byte-order format;
  4324. `ld' will read any version or byte order, but the output header format
  4325. depends on the default specified by the specific target.
  4326.  
  4327. 
  4328. File: ld.info,  Node: WIN32,  Next: Xtensa,  Prev: TI COFF,  Up: Machine Dependent
  4329.  
  4330. 4.8 `ld' and WIN32 (cygwin/mingw)
  4331. =================================
  4332.  
  4333. This section describes some of the win32 specific `ld' issues.  See
  4334. *Note Command Line Options: Options. for detailed decription of the
  4335. command line options mentioned here.
  4336.  
  4337. _import libraries_
  4338.      The standard Windows linker creates and uses so-called import
  4339.      libraries, which contains information for linking to dll's.  They
  4340.      are regular static archives and are handled as any other static
  4341.      archive.  The cygwin and mingw ports of `ld' have specific support
  4342.      for creating such libraries provided with the `--out-implib'
  4343.      command line option.
  4344.  
  4345. _exporting DLL symbols_
  4346.      The cygwin/mingw `ld' has several ways to export symbols for dll's.
  4347.  
  4348.     _using auto-export functionality_
  4349.           By default `ld' exports symbols with the auto-export
  4350.           functionality, which is controlled by the following command
  4351.           line options:
  4352.  
  4353.              * -export-all-symbols   [This is the default]
  4354.  
  4355.              * -exclude-symbols
  4356.  
  4357.              * -exclude-libs
  4358.  
  4359.           If, however, `--export-all-symbols' is not given explicitly
  4360.           on the command line, then the default auto-export behavior
  4361.           will be _disabled_ if either of the following are true:
  4362.  
  4363.              * A DEF file is used.
  4364.  
  4365.              * Any symbol in any object file was marked with the
  4366.                __declspec(dllexport) attribute.
  4367.  
  4368.     _using a DEF file_
  4369.           Another way of exporting symbols is using a DEF file.  A DEF
  4370.           file is an ASCII file containing definitions of symbols which
  4371.           should be exported when a dll is created.  Usually it is
  4372.           named `<dll name>.def' and is added as any other object file
  4373.           to the linker's command line.  The file's name must end in
  4374.           `.def' or `.DEF'.
  4375.  
  4376.                gcc -o <output> <objectfiles> <dll name>.def
  4377.  
  4378.           Using a DEF file turns off the normal auto-export behavior,
  4379.           unless the `--export-all-symbols' option is also used.
  4380.  
  4381.           Here is an example of a DEF file for a shared library called
  4382.           `xyz.dll':
  4383.  
  4384.                LIBRARY "xyz.dll" BASE=0x10000000
  4385.  
  4386.                EXPORTS
  4387.                foo
  4388.                bar
  4389.                _bar = bar
  4390.  
  4391.           This example defines a base address and three symbols.  The
  4392.           third symbol is an alias for the second.  For the complete
  4393.           format specification see ld/deffilep.y in the binutils
  4394.           sources.
  4395.  
  4396.           While linking a shared dll, `ld' is able to create a DEF file
  4397.           with the `--output-def <file>' command line option.
  4398.  
  4399.     _Using decorations_
  4400.           Another way of marking symbols for export is to modify the
  4401.           source code itself, so that when building the DLL each symbol
  4402.           to be exported is declared as:
  4403.  
  4404.                __declspec(dllexport) int a_variable
  4405.                __declspec(dllexport) void a_function(int with_args)
  4406.  
  4407.           All such symbols will be exported from the DLL.  If, however,
  4408.           any of the object files in the DLL contain symbols decorated
  4409.           in this way, then the normal auto-export behavior is
  4410.           disabled, unless the `--export-all-symbols' option is also
  4411.           used.
  4412.  
  4413.           Note that object files that wish to access these symbols must
  4414.           _not_ decorate them with dllexport.  Instead, they should use
  4415.           dllimport, instead:
  4416.  
  4417.                __declspec(dllimport) int a_variable
  4418.                __declspec(dllimport) void a_function(int with_args)
  4419.  
  4420.           This complicates the structure of library header files,
  4421.           because when included by the library itself the header must
  4422.           declare the variables and functions as dllexport, but when
  4423.           included by client code the header must declare them as
  4424.           dllimport.  There are a number of idioms that are typically
  4425.           used to do this; often client code can omit the __declspec()
  4426.           declaration completely.  See `--enable-auto-import' and
  4427.           `automatic data imports' for more imformation.
  4428.  
  4429. _automatic data imports_
  4430.      The standard Windows dll format supports data imports from dlls
  4431.      only by adding special decorations (dllimport/dllexport), which
  4432.      let the compiler produce specific assembler instructions to deal
  4433.      with this issue.  This increases the effort necessary to port
  4434.      existing Un*x code to these platforms, especially for large c++
  4435.      libraries and applications.  The auto-import feature, which was
  4436.      initially provided by Paul Sokolovsky, allows one to omit the
  4437.      decorations to archieve a behavior that conforms to that on
  4438.      POSIX/Un*x platforms. This feature is enabled with the
  4439.      `--enable-auto-import' command-line option, although it is enabled
  4440.      by default on cygwin/mingw.  The `--enable-auto-import' option
  4441.      itself now serves mainly to suppress any warnings that are
  4442.      ordinarily emitted when linked objects trigger the feature's use.
  4443.  
  4444.      auto-import of variables does not always work flawlessly without
  4445.      additional assistance.  Sometimes, you will see this message
  4446.  
  4447.      "variable '<var>' can't be auto-imported. Please read the
  4448.      documentation for ld's `--enable-auto-import' for details."
  4449.  
  4450.      The `--enable-auto-import' documentation explains why this error
  4451.      occurs, and several methods that can be used to overcome this
  4452.      difficulty.  One of these methods is the _runtime pseudo-relocs_
  4453.      feature, described below.
  4454.  
  4455.      For complex variables imported from DLLs (such as structs or
  4456.      classes), object files typically contain a base address for the
  4457.      variable and an offset (_addend_) within the variable-to specify a
  4458.      particular field or public member, for instance.  Unfortunately,
  4459.      the runtime loader used in win32 environments is incapable of
  4460.      fixing these references at runtime without the additional
  4461.      information supplied by dllimport/dllexport decorations.  The
  4462.      standard auto-import feature described above is unable to resolve
  4463.      these references.
  4464.  
  4465.      The `--enable-runtime-pseudo-relocs' switch allows these
  4466.      references to be resolved without error, while leaving the task of
  4467.      adjusting the references themselves (with their non-zero addends)
  4468.      to specialized code provided by the runtime environment.  Recent
  4469.      versions of the cygwin and mingw environments and compilers
  4470.      provide this runtime support; older versions do not.  However, the
  4471.      support is only necessary on the developer's platform; the
  4472.      compiled result will run without error on an older system.
  4473.  
  4474.      `--enable-runtime-pseudo-relocs' is not the default; it must be
  4475.      explicitly enabled as needed.
  4476.  
  4477. _direct linking to a dll_
  4478.      The cygwin/mingw ports of `ld' support the direct linking,
  4479.      including data symbols, to a dll without the usage of any import
  4480.      libraries.  This is much faster and uses much less memory than
  4481.      does the traditional import library method, expecially when
  4482.      linking large libraries or applications.  When `ld' creates an
  4483.      import lib, each function or variable exported from the dll is
  4484.      stored in its own bfd, even though a single bfd could contain many
  4485.      exports.  The overhead involved in storing, loading, and
  4486.      processing so many bfd's is quite large, and explains the
  4487.      tremendous time, memory, and storage needed to link against
  4488.      particularly large or complex libraries when using import libs.
  4489.  
  4490.      Linking directly to a dll uses no extra command-line switches
  4491.      other than `-L' and `-l', because `ld' already searches for a
  4492.      number of names to match each library.  All that is needed from
  4493.      the developer's perspective is an understanding of this search, in
  4494.      order to force ld to select the dll instead of an import library.
  4495.  
  4496.      For instance, when ld is called with the argument `-lxxx' it will
  4497.      attempt to find, in the first directory of its search path,
  4498.  
  4499.           libxxx.dll.a
  4500.           xxx.dll.a
  4501.           libxxx.a
  4502.           cygxxx.dll (*)
  4503.           libxxx.dll
  4504.           xxx.dll
  4505.  
  4506.      before moving on to the next directory in the search path.
  4507.  
  4508.      (*) Actually, this is not `cygxxx.dll' but in fact is
  4509.      `<prefix>xxx.dll', where `<prefix>' is set by the `ld' option
  4510.      `--dll-search-prefix=<prefix>'. In the case of cygwin, the
  4511.      standard gcc spec file includes `--dll-search-prefix=cyg', so in
  4512.      effect we actually search for `cygxxx.dll'.
  4513.  
  4514.      Other win32-based unix environments, such as mingw or pw32, may
  4515.      use other `<prefix>'es, although at present only cygwin makes use
  4516.      of this feature.  It was originally intended to help avoid name
  4517.      conflicts among dll's built for the various win32/un*x
  4518.      environments, so that (for example) two versions of a zlib dll
  4519.      could coexist on the same machine.
  4520.  
  4521.      The generic cygwin/mingw path layout uses a `bin' directory for
  4522.      applications and dll's and a `lib' directory for the import
  4523.      libraries (using cygwin nomenclature):
  4524.  
  4525.           bin/
  4526.               cygxxx.dll
  4527.           lib/
  4528.               libxxx.dll.a   (in case of dll's)
  4529.               libxxx.a       (in case of static archive)
  4530.  
  4531.      Linking directly to a dll without using the import library can be
  4532.      done two ways:
  4533.  
  4534.      1. Use the dll directly by adding the `bin' path to the link line
  4535.           gcc -Wl,-verbose  -o a.exe -L../bin/ -lxxx
  4536.  
  4537.      However, as the dll's often have version numbers appended to their
  4538.      names (`cygncurses-5.dll') this will often fail, unless one
  4539.      specifies `-L../bin -lncurses-5' to include the version.  Import
  4540.      libs are generally not versioned, and do not have this difficulty.
  4541.  
  4542.      2. Create a symbolic link from the dll to a file in the `lib'
  4543.      directory according to the above mentioned search pattern.  This
  4544.      should be used to avoid unwanted changes in the tools needed for
  4545.      making the app/dll.
  4546.  
  4547.           ln -s bin/cygxxx.dll lib/[cyg|lib|]xxx.dll[.a]
  4548.  
  4549.      Then you can link without any make environment changes.
  4550.  
  4551.           gcc -Wl,-verbose  -o a.exe -L../lib/ -lxxx
  4552.  
  4553.      This technique also avoids the version number problems, because
  4554.      the following is perfectly legal
  4555.  
  4556.           bin/
  4557.               cygxxx-5.dll
  4558.           lib/
  4559.               libxxx.dll.a -> ../bin/cygxxx-5.dll
  4560.  
  4561.      Linking directly to a dll without using an import lib will work
  4562.      even when auto-import features are exercised, and even when
  4563.      `--enable-runtime-pseudo-relocs' is used.
  4564.  
  4565.      Given the improvements in speed and memory usage, one might
  4566.      justifiably wonder why import libraries are used at all.  There
  4567.      are two reasons:
  4568.  
  4569.      1. Until recently, the link-directly-to-dll functionality did _not_
  4570.      work with auto-imported data.
  4571.  
  4572.      2. Sometimes it is necessary to include pure static objects within
  4573.      the import library (which otherwise contains only bfd's for
  4574.      indirection symbols that point to the exports of a dll).  Again,
  4575.      the import lib for the cygwin kernel makes use of this ability,
  4576.      and it is not possible to do this without an import lib.
  4577.  
  4578.      So, import libs are not going away.  But the ability to replace
  4579.      true import libs with a simple symbolic link to (or a copy of) a
  4580.      dll, in most cases, is a useful addition to the suite of tools
  4581.      binutils makes available to the win32 developer.  Given the
  4582.      massive improvements in memory requirements during linking, storage
  4583.      requirements, and linking speed, we expect that many developers
  4584.      will soon begin to use this feature whenever possible.
  4585.  
  4586. _symbol aliasing_
  4587.  
  4588.     _adding additional names_
  4589.           Sometimes, it is useful to export symbols with additional
  4590.           names.  A symbol `foo' will be exported as `foo', but it can
  4591.           also be exported as `_foo' by using special directives in the
  4592.           DEF file when creating the dll.  This will affect also the
  4593.           optional created import library.  Consider the following DEF
  4594.           file:
  4595.  
  4596.                LIBRARY "xyz.dll" BASE=0x61000000
  4597.  
  4598.                EXPORTS
  4599.                foo
  4600.                _foo = foo
  4601.  
  4602.           The line `_foo = foo' maps the symbol `foo' to `_foo'.
  4603.  
  4604.           Another method for creating a symbol alias is to create it in
  4605.           the source code using the "weak" attribute:
  4606.  
  4607.                void foo () { /* Do something.  */; }
  4608.                void _foo () __attribute__ ((weak, alias ("foo")));
  4609.  
  4610.           See the gcc manual for more information about attributes and
  4611.           weak symbols.
  4612.  
  4613.     _renaming symbols_
  4614.           Sometimes it is useful to rename exports.  For instance, the
  4615.           cygwin kernel does this regularly.  A symbol `_foo' can be
  4616.           exported as `foo' but not as `_foo' by using special
  4617.           directives in the DEF file. (This will also affect the import
  4618.           library, if it is created).  In the following example:
  4619.  
  4620.                LIBRARY "xyz.dll" BASE=0x61000000
  4621.  
  4622.                EXPORTS
  4623.                _foo = foo
  4624.  
  4625.           The line `_foo = foo' maps the exported symbol `foo' to
  4626.           `_foo'.
  4627.  
  4628.      Note: using a DEF file disables the default auto-export behavior,
  4629.      unless the `--export-all-symbols' command line option is used.
  4630.      If, however, you are trying to rename symbols, then you should list
  4631.      _all_ desired exports in the DEF file, including the symbols that
  4632.      are not being renamed, and do _not_ use the `--export-all-symbols'
  4633.      option.  If you list only the renamed symbols in the DEF file, and
  4634.      use `--export-all-symbols' to handle the other symbols, then the
  4635.      both the new names _and_ the original names for the renamed
  4636.      symbols will be exported.  In effect, you'd be aliasing those
  4637.      symbols, not renaming them, which is probably not what you wanted.
  4638.  
  4639. _weak externals_
  4640.      The Windows object format, PE, specifies a form of weak symbols
  4641.      called weak externals.  When a weak symbol is linked and the
  4642.      symbol is not defined, the weak symbol becomes an alias for some
  4643.      other symbol.  There are three variants of weak externals:
  4644.         * Definition is searched for in objects and libraries,
  4645.           historically called lazy externals.
  4646.  
  4647.         * Definition is searched for only in other objects, not in
  4648.           libraries.  This form is not presently implemented.
  4649.  
  4650.         * No search; the symbol is an alias.  This form is not presently
  4651.           implemented.
  4652.      As a GNU extension, weak symbols that do not specify an alternate
  4653.      symbol are supported.  If the symbol is undefined when linking,
  4654.      the symbol uses a default value.
  4655.  
  4656. 
  4657. File: ld.info,  Node: Xtensa,  Prev: WIN32,  Up: Machine Dependent
  4658.  
  4659. 4.9 `ld' and Xtensa Processors
  4660. ==============================
  4661.  
  4662. The default `ld' behavior for Xtensa processors is to interpret
  4663. `SECTIONS' commands so that lists of explicitly named sections in a
  4664. specification with a wildcard file will be interleaved when necessary to
  4665. keep literal pools within the range of PC-relative load offsets.  For
  4666. example, with the command:
  4667.  
  4668.      SECTIONS
  4669.      {
  4670.        .text : {
  4671.          *(.literal .text)
  4672.        }
  4673.      }
  4674.  
  4675. `ld' may interleave some of the `.literal' and `.text' sections from
  4676. different object files to ensure that the literal pools are within the
  4677. range of PC-relative load offsets.  A valid interleaving might place
  4678. the `.literal' sections from an initial group of files followed by the
  4679. `.text' sections of that group of files.  Then, the `.literal' sections
  4680. from the rest of the files and the `.text' sections from the rest of
  4681. the files would follow.
  4682.  
  4683.    Relaxation is enabled by default for the Xtensa version of `ld' and
  4684. provides two important link-time optimizations.  The first optimization
  4685. is to combine identical literal values to reduce code size.  A redundant
  4686. literal will be removed and all the `L32R' instructions that use it
  4687. will be changed to reference an identical literal, as long as the
  4688. location of the replacement literal is within the offset range of all
  4689. the `L32R' instructions.  The second optimization is to remove
  4690. unnecessary overhead from assembler-generated "longcall" sequences of
  4691. `L32R'/`CALLXN' when the target functions are within range of direct
  4692. `CALLN' instructions.
  4693.  
  4694.    For each of these cases where an indirect call sequence can be
  4695. optimized to a direct call, the linker will change the `CALLXN'
  4696. instruction to a `CALLN' instruction, remove the `L32R' instruction,
  4697. and remove the literal referenced by the `L32R' instruction if it is
  4698. not used for anything else.  Removing the `L32R' instruction always
  4699. reduces code size but can potentially hurt performance by changing the
  4700. alignment of subsequent branch targets.  By default, the linker will
  4701. always preserve alignments, either by switching some instructions
  4702. between 24-bit encodings and the equivalent density instructions or by
  4703. inserting a no-op in place of the `L32R' instruction that was removed.
  4704. If code size is more important than performance, the `--size-opt'
  4705. option can be used to prevent the linker from widening density
  4706. instructions or inserting no-ops, except in a few cases where no-ops
  4707. are required for correctness.
  4708.  
  4709.    The following Xtensa-specific command-line options can be used to
  4710. control the linker:
  4711.  
  4712. `--no-relax'
  4713.      Since the Xtensa version of `ld' enables the `--relax' option by
  4714.      default, the `--no-relax' option is provided to disable relaxation.
  4715.  
  4716. `--size-opt'
  4717.      When optimizing indirect calls to direct calls, optimize for code
  4718.      size more than performance.  With this option, the linker will not
  4719.      insert no-ops or widen density instructions to preserve branch
  4720.      target alignment.  There may still be some cases where no-ops are
  4721.      required to preserve the correctness of the code.
  4722.  
  4723. 
  4724. File: ld.info,  Node: BFD,  Next: Reporting Bugs,  Prev: Machine Dependent,  Up: Top
  4725.  
  4726. 5 BFD
  4727. *****
  4728.  
  4729. The linker accesses object and archive files using the BFD libraries.
  4730. These libraries allow the linker to use the same routines to operate on
  4731. object files whatever the object file format.  A different object file
  4732. format can be supported simply by creating a new BFD back end and adding
  4733. it to the library.  To conserve runtime memory, however, the linker and
  4734. associated tools are usually configured to support only a subset of the
  4735. object file formats available.  You can use `objdump -i' (*note
  4736. objdump: (binutils.info)objdump.) to list all the formats available for
  4737. your configuration.
  4738.  
  4739.    As with most implementations, BFD is a compromise between several
  4740. conflicting requirements. The major factor influencing BFD design was
  4741. efficiency: any time used converting between formats is time which
  4742. would not have been spent had BFD not been involved. This is partly
  4743. offset by abstraction payback; since BFD simplifies applications and
  4744. back ends, more time and care may be spent optimizing algorithms for a
  4745. greater speed.
  4746.  
  4747.    One minor artifact of the BFD solution which you should bear in mind
  4748. is the potential for information loss.  There are two places where
  4749. useful information can be lost using the BFD mechanism: during
  4750. conversion and during output. *Note BFD information loss::.
  4751.  
  4752. * Menu:
  4753.  
  4754. * BFD outline::                 How it works: an outline of BFD
  4755.  
  4756. 
  4757. File: ld.info,  Node: BFD outline,  Up: BFD
  4758.  
  4759. 5.1 How It Works: An Outline of BFD
  4760. ===================================
  4761.  
  4762. When an object file is opened, BFD subroutines automatically determine
  4763. the format of the input object file.  They then build a descriptor in
  4764. memory with pointers to routines that will be used to access elements of
  4765. the object file's data structures.
  4766.  
  4767.    As different information from the object files is required, BFD
  4768. reads from different sections of the file and processes them.  For
  4769. example, a very common operation for the linker is processing symbol
  4770. tables.  Each BFD back end provides a routine for converting between
  4771. the object file's representation of symbols and an internal canonical
  4772. format. When the linker asks for the symbol table of an object file, it
  4773. calls through a memory pointer to the routine from the relevant BFD
  4774. back end which reads and converts the table into a canonical form.  The
  4775. linker then operates upon the canonical form. When the link is finished
  4776. and the linker writes the output file's symbol table, another BFD back
  4777. end routine is called to take the newly created symbol table and
  4778. convert it into the chosen output format.
  4779.  
  4780. * Menu:
  4781.  
  4782. * BFD information loss::    Information Loss
  4783. * Canonical format::        The BFD    canonical object-file format
  4784.  
  4785. 
  4786. File: ld.info,  Node: BFD information loss,  Next: Canonical format,  Up: BFD outline
  4787.  
  4788. 5.1.1 Information Loss
  4789. ----------------------
  4790.  
  4791. _Information can be lost during output._ The output formats supported
  4792. by BFD do not provide identical facilities, and information which can
  4793. be described in one form has nowhere to go in another format. One
  4794. example of this is alignment information in `b.out'. There is nowhere
  4795. in an `a.out' format file to store alignment information on the
  4796. contained data, so when a file is linked from `b.out' and an `a.out'
  4797. image is produced, alignment information will not propagate to the
  4798. output file. (The linker will still use the alignment information
  4799. internally, so the link is performed correctly).
  4800.  
  4801.    Another example is COFF section names. COFF files may contain an
  4802. unlimited number of sections, each one with a textual section name. If
  4803. the target of the link is a format which does not have many sections
  4804. (e.g., `a.out') or has sections without names (e.g., the Oasys format),
  4805. the link cannot be done simply. You can circumvent this problem by
  4806. describing the desired input-to-output section mapping with the linker
  4807. command language.
  4808.  
  4809.    _Information can be lost during canonicalization._ The BFD internal
  4810. canonical form of the external formats is not exhaustive; there are
  4811. structures in input formats for which there is no direct representation
  4812. internally.  This means that the BFD back ends cannot maintain all
  4813. possible data richness through the transformation between external to
  4814. internal and back to external formats.
  4815.  
  4816.    This limitation is only a problem when an application reads one
  4817. format and writes another.  Each BFD back end is responsible for
  4818. maintaining as much data as possible, and the internal BFD canonical
  4819. form has structures which are opaque to the BFD core, and exported only
  4820. to the back ends. When a file is read in one format, the canonical form
  4821. is generated for BFD and the application. At the same time, the back
  4822. end saves away any information which may otherwise be lost. If the data
  4823. is then written back in the same format, the back end routine will be
  4824. able to use the canonical form provided by the BFD core as well as the
  4825. information it prepared earlier.  Since there is a great deal of
  4826. commonality between back ends, there is no information lost when
  4827. linking or copying big endian COFF to little endian COFF, or `a.out' to
  4828. `b.out'.  When a mixture of formats is linked, the information is only
  4829. lost from the files whose format differs from the destination.
  4830.  
  4831. 
  4832. File: ld.info,  Node: Canonical format,  Prev: BFD information loss,  Up: BFD outline
  4833.  
  4834. 5.1.2 The BFD canonical object-file format
  4835. ------------------------------------------
  4836.  
  4837. The greatest potential for loss of information occurs when there is the
  4838. least overlap between the information provided by the source format,
  4839. that stored by the canonical format, and that needed by the destination
  4840. format. A brief description of the canonical form may help you
  4841. understand which kinds of data you can count on preserving across
  4842. conversions.  
  4843.  
  4844. _files_
  4845.      Information stored on a per-file basis includes target machine
  4846.      architecture, particular implementation format type, a demand
  4847.      pageable bit, and a write protected bit.  Information like Unix
  4848.      magic numbers is not stored here--only the magic numbers' meaning,
  4849.      so a `ZMAGIC' file would have both the demand pageable bit and the
  4850.      write protected text bit set.  The byte order of the target is
  4851.      stored on a per-file basis, so that big- and little-endian object
  4852.      files may be used with one another.
  4853.  
  4854. _sections_
  4855.      Each section in the input file contains the name of the section,
  4856.      the section's original address in the object file, size and
  4857.      alignment information, various flags, and pointers into other BFD
  4858.      data structures.
  4859.  
  4860. _symbols_
  4861.      Each symbol contains a pointer to the information for the object
  4862.      file which originally defined it, its name, its value, and various
  4863.      flag bits.  When a BFD back end reads in a symbol table, it
  4864.      relocates all symbols to make them relative to the base of the
  4865.      section where they were defined.  Doing this ensures that each
  4866.      symbol points to its containing section.  Each symbol also has a
  4867.      varying amount of hidden private data for the BFD back end.  Since
  4868.      the symbol points to the original file, the private data format
  4869.      for that symbol is accessible.  `ld' can operate on a collection
  4870.      of symbols of wildly different formats without problems.
  4871.  
  4872.      Normal global and simple local symbols are maintained on output,
  4873.      so an output file (no matter its format) will retain symbols
  4874.      pointing to functions and to global, static, and common variables.
  4875.      Some symbol information is not worth retaining; in `a.out', type
  4876.      information is stored in the symbol table as long symbol names.
  4877.      This information would be useless to most COFF debuggers; the
  4878.      linker has command line switches to allow users to throw it away.
  4879.  
  4880.      There is one word of type information within the symbol, so if the
  4881.      format supports symbol type information within symbols (for
  4882.      example, COFF, IEEE, Oasys) and the type is simple enough to fit
  4883.      within one word (nearly everything but aggregates), the
  4884.      information will be preserved.
  4885.  
  4886. _relocation level_
  4887.      Each canonical BFD relocation record contains a pointer to the
  4888.      symbol to relocate to, the offset of the data to relocate, the
  4889.      section the data is in, and a pointer to a relocation type
  4890.      descriptor. Relocation is performed by passing messages through
  4891.      the relocation type descriptor and the symbol pointer. Therefore,
  4892.      relocations can be performed on output data using a relocation
  4893.      method that is only available in one of the input formats. For
  4894.      instance, Oasys provides a byte relocation format.  A relocation
  4895.      record requesting this relocation type would point indirectly to a
  4896.      routine to perform this, so the relocation may be performed on a
  4897.      byte being written to a 68k COFF file, even though 68k COFF has no
  4898.      such relocation type.
  4899.  
  4900. _line numbers_
  4901.      Object formats can contain, for debugging purposes, some form of
  4902.      mapping between symbols, source line numbers, and addresses in the
  4903.      output file.  These addresses have to be relocated along with the
  4904.      symbol information.  Each symbol with an associated list of line
  4905.      number records points to the first record of the list.  The head
  4906.      of a line number list consists of a pointer to the symbol, which
  4907.      allows finding out the address of the function whose line number
  4908.      is being described. The rest of the list is made up of pairs:
  4909.      offsets into the section and line numbers. Any format which can
  4910.      simply derive this information can pass it successfully between
  4911.      formats (COFF, IEEE and Oasys).
  4912.  
  4913. 
  4914. File: ld.info,  Node: Reporting Bugs,  Next: MRI,  Prev: BFD,  Up: Top
  4915.  
  4916. 6 Reporting Bugs
  4917. ****************
  4918.  
  4919. Your bug reports play an essential role in making `ld' reliable.
  4920.  
  4921.    Reporting a bug may help you by bringing a solution to your problem,
  4922. or it may not.  But in any case the principal function of a bug report
  4923. is to help the entire community by making the next version of `ld' work
  4924. better.  Bug reports are your contribution to the maintenance of `ld'.
  4925.  
  4926.    In order for a bug report to serve its purpose, you must include the
  4927. information that enables us to fix the bug.
  4928.  
  4929. * Menu:
  4930.  
  4931. * Bug Criteria::                Have you found a bug?
  4932. * Bug Reporting::               How to report bugs
  4933.  
  4934. 
  4935. File: ld.info,  Node: Bug Criteria,  Next: Bug Reporting,  Up: Reporting Bugs
  4936.  
  4937. 6.1 Have You Found a Bug?
  4938. =========================
  4939.  
  4940. If you are not sure whether you have found a bug, here are some
  4941. guidelines:
  4942.  
  4943.    * If the linker gets a fatal signal, for any input whatever, that is
  4944.      a `ld' bug.  Reliable linkers never crash.
  4945.  
  4946.    * If `ld' produces an error message for valid input, that is a bug.
  4947.  
  4948.    * If `ld' does not produce an error message for invalid input, that
  4949.      may be a bug.  In the general case, the linker can not verify that
  4950.      object files are correct.
  4951.  
  4952.    * If you are an experienced user of linkers, your suggestions for
  4953.      improvement of `ld' are welcome in any case.
  4954.  
  4955. 
  4956. File: ld.info,  Node: Bug Reporting,  Prev: Bug Criteria,  Up: Reporting Bugs
  4957.  
  4958. 6.2 How to Report Bugs
  4959. ======================
  4960.  
  4961. A number of companies and individuals offer support for GNU products.
  4962. If you obtained `ld' from a support organization, we recommend you
  4963. contact that organization first.
  4964.  
  4965.    You can find contact information for many support companies and
  4966. individuals in the file `etc/SERVICE' in the GNU Emacs distribution.
  4967.  
  4968.    Otherwise, send bug reports for `ld' to `bug-binutils@gnu.org'.
  4969.  
  4970.    The fundamental principle of reporting bugs usefully is this:
  4971. *report all the facts*.  If you are not sure whether to state a fact or
  4972. leave it out, state it!
  4973.  
  4974.    Often people omit facts because they think they know what causes the
  4975. problem and assume that some details do not matter.  Thus, you might
  4976. assume that the name of a symbol you use in an example does not matter.
  4977. Well, probably it does not, but one cannot be sure.  Perhaps the bug
  4978. is a stray memory reference which happens to fetch from the location
  4979. where that name is stored in memory; perhaps, if the name were
  4980. different, the contents of that location would fool the linker into
  4981. doing the right thing despite the bug.  Play it safe and give a
  4982. specific, complete example.  That is the easiest thing for you to do,
  4983. and the most helpful.
  4984.  
  4985.    Keep in mind that the purpose of a bug report is to enable us to fix
  4986. the bug if it is new to us.  Therefore, always write your bug reports
  4987. on the assumption that the bug has not been reported previously.
  4988.  
  4989.    Sometimes people give a few sketchy facts and ask, "Does this ring a
  4990. bell?"  This cannot help us fix a bug, so it is basically useless.  We
  4991. respond by asking for enough details to enable us to investigate.  You
  4992. might as well expedite matters by sending them to begin with.
  4993.  
  4994.    To enable us to fix the bug, you should include all these things:
  4995.  
  4996.    * The version of `ld'.  `ld' announces it if you start it with the
  4997.      `--version' argument.
  4998.  
  4999.      Without this, we will not know whether there is any point in
  5000.      looking for the bug in the current version of `ld'.
  5001.  
  5002.    * Any patches you may have applied to the `ld' source, including any
  5003.      patches made to the `BFD' library.
  5004.  
  5005.    * The type of machine you are using, and the operating system name
  5006.      and version number.
  5007.  
  5008.    * What compiler (and its version) was used to compile `ld'--e.g.
  5009.      "`gcc-2.7'".
  5010.  
  5011.    * The command arguments you gave the linker to link your example and
  5012.      observe the bug.  To guarantee you will not omit something
  5013.      important, list them all.  A copy of the Makefile (or the output
  5014.      from make) is sufficient.
  5015.  
  5016.      If we were to try to guess the arguments, we would probably guess
  5017.      wrong and then we might not encounter the bug.
  5018.  
  5019.    * A complete input file, or set of input files, that will reproduce
  5020.      the bug.  It is generally most helpful to send the actual object
  5021.      files provided that they are reasonably small.  Say no more than
  5022.      10K.  For bigger files you can either make them available by FTP
  5023.      or HTTP or else state that you are willing to send the object
  5024.      file(s) to whomever requests them.  (Note - your email will be
  5025.      going to a mailing list, so we do not want to clog it up with
  5026.      large attachments).  But small attachments are best.
  5027.  
  5028.      If the source files were assembled using `gas' or compiled using
  5029.      `gcc', then it may be OK to send the source files rather than the
  5030.      object files.  In this case, be sure to say exactly what version of
  5031.      `gas' or `gcc' was used to produce the object files.  Also say how
  5032.      `gas' or `gcc' were configured.
  5033.  
  5034.    * A description of what behavior you observe that you believe is
  5035.      incorrect.  For example, "It gets a fatal signal."
  5036.  
  5037.      Of course, if the bug is that `ld' gets a fatal signal, then we
  5038.      will certainly notice it.  But if the bug is incorrect output, we
  5039.      might not notice unless it is glaringly wrong.  You might as well
  5040.      not give us a chance to make a mistake.
  5041.  
  5042.      Even if the problem you experience is a fatal signal, you should
  5043.      still say so explicitly.  Suppose something strange is going on,
  5044.      such as, your copy of `ld' is out of synch, or you have
  5045.      encountered a bug in the C library on your system.  (This has
  5046.      happened!)  Your copy might crash and ours would not.  If you told
  5047.      us to expect a crash, then when ours fails to crash, we would know
  5048.      that the bug was not happening for us.  If you had not told us to
  5049.      expect a crash, then we would not be able to draw any conclusion
  5050.      from our observations.
  5051.  
  5052.    * If you wish to suggest changes to the `ld' source, send us context
  5053.      diffs, as generated by `diff' with the `-u', `-c', or `-p' option.
  5054.      Always send diffs from the old file to the new file.  If you even
  5055.      discuss something in the `ld' source, refer to it by context, not
  5056.      by line number.
  5057.  
  5058.      The line numbers in our development sources will not match those
  5059.      in your sources.  Your line numbers would convey no useful
  5060.      information to us.
  5061.  
  5062.    Here are some things that are not necessary:
  5063.  
  5064.    * A description of the envelope of the bug.
  5065.  
  5066.      Often people who encounter a bug spend a lot of time investigating
  5067.      which changes to the input file will make the bug go away and which
  5068.      changes will not affect it.
  5069.  
  5070.      This is often time consuming and not very useful, because the way
  5071.      we will find the bug is by running a single example under the
  5072.      debugger with breakpoints, not by pure deduction from a series of
  5073.      examples.  We recommend that you save your time for something else.
  5074.  
  5075.      Of course, if you can find a simpler example to report _instead_
  5076.      of the original one, that is a convenience for us.  Errors in the
  5077.      output will be easier to spot, running under the debugger will take
  5078.      less time, and so on.
  5079.  
  5080.      However, simplification is not vital; if you do not want to do
  5081.      this, report the bug anyway and send us the entire test case you
  5082.      used.
  5083.  
  5084.    * A patch for the bug.
  5085.  
  5086.      A patch for the bug does help us if it is a good one.  But do not
  5087.      omit the necessary information, such as the test case, on the
  5088.      assumption that a patch is all we need.  We might see problems
  5089.      with your patch and decide to fix the problem another way, or we
  5090.      might not understand it at all.
  5091.  
  5092.      Sometimes with a program as complicated as `ld' it is very hard to
  5093.      construct an example that will make the program follow a certain
  5094.      path through the code.  If you do not send us the example, we will
  5095.      not be able to construct one, so we will not be able to verify
  5096.      that the bug is fixed.
  5097.  
  5098.      And if we cannot understand what bug you are trying to fix, or why
  5099.      your patch should be an improvement, we will not install it.  A
  5100.      test case will help us to understand.
  5101.  
  5102.    * A guess about what the bug is or what it depends on.
  5103.  
  5104.      Such guesses are usually wrong.  Even we cannot guess right about
  5105.      such things without first using the debugger to find the facts.
  5106.  
  5107. 
  5108. File: ld.info,  Node: MRI,  Next: GNU Free Documentation License,  Prev: Reporting Bugs,  Up: Top
  5109.  
  5110. Appendix A MRI Compatible Script Files
  5111. **************************************
  5112.  
  5113. To aid users making the transition to GNU `ld' from the MRI linker,
  5114. `ld' can use MRI compatible linker scripts as an alternative to the
  5115. more general-purpose linker scripting language described in *Note
  5116. Scripts::.  MRI compatible linker scripts have a much simpler command
  5117. set than the scripting language otherwise used with `ld'.  GNU `ld'
  5118. supports the most commonly used MRI linker commands; these commands are
  5119. described here.
  5120.  
  5121.    In general, MRI scripts aren't of much use with the `a.out' object
  5122. file format, since it only has three sections and MRI scripts lack some
  5123. features to make use of them.
  5124.  
  5125.    You can specify a file containing an MRI-compatible script using the
  5126. `-c' command-line option.
  5127.  
  5128.    Each command in an MRI-compatible script occupies its own line; each
  5129. command line starts with the keyword that identifies the command (though
  5130. blank lines are also allowed for punctuation).  If a line of an
  5131. MRI-compatible script begins with an unrecognized keyword, `ld' issues
  5132. a warning message, but continues processing the script.
  5133.  
  5134.    Lines beginning with `*' are comments.
  5135.  
  5136.    You can write these commands using all upper-case letters, or all
  5137. lower case; for example, `chip' is the same as `CHIP'.  The following
  5138. list shows only the upper-case form of each command.
  5139.  
  5140. `ABSOLUTE SECNAME'
  5141. `ABSOLUTE SECNAME, SECNAME, ... SECNAME'
  5142.      Normally, `ld' includes in the output file all sections from all
  5143.      the input files.  However, in an MRI-compatible script, you can
  5144.      use the `ABSOLUTE' command to restrict the sections that will be
  5145.      present in your output program.  If the `ABSOLUTE' command is used
  5146.      at all in a script, then only the sections named explicitly in
  5147.      `ABSOLUTE' commands will appear in the linker output.  You can
  5148.      still use other input sections (whatever you select on the command
  5149.      line, or using `LOAD') to resolve addresses in the output file.
  5150.  
  5151. `ALIAS OUT-SECNAME, IN-SECNAME'
  5152.      Use this command to place the data from input section IN-SECNAME
  5153.      in a section called OUT-SECNAME in the linker output file.
  5154.  
  5155.      IN-SECNAME may be an integer.
  5156.  
  5157. `ALIGN SECNAME = EXPRESSION'
  5158.      Align the section called SECNAME to EXPRESSION.  The EXPRESSION
  5159.      should be a power of two.
  5160.  
  5161. `BASE EXPRESSION'
  5162.      Use the value of EXPRESSION as the lowest address (other than
  5163.      absolute addresses) in the output file.
  5164.  
  5165. `CHIP EXPRESSION'
  5166. `CHIP EXPRESSION, EXPRESSION'
  5167.      This command does nothing; it is accepted only for compatibility.
  5168.  
  5169. `END'
  5170.      This command does nothing whatever; it's only accepted for
  5171.      compatibility.
  5172.  
  5173. `FORMAT OUTPUT-FORMAT'
  5174.      Similar to the `OUTPUT_FORMAT' command in the more general linker
  5175.      language, but restricted to one of these output formats:
  5176.  
  5177.        1. S-records, if OUTPUT-FORMAT is `S'
  5178.  
  5179.        2. IEEE, if OUTPUT-FORMAT is `IEEE'
  5180.  
  5181.        3. COFF (the `coff-m68k' variant in BFD), if OUTPUT-FORMAT is
  5182.           `COFF'
  5183.  
  5184. `LIST ANYTHING...'
  5185.      Print (to the standard output file) a link map, as produced by the
  5186.      `ld' command-line option `-M'.
  5187.  
  5188.      The keyword `LIST' may be followed by anything on the same line,
  5189.      with no change in its effect.
  5190.  
  5191. `LOAD FILENAME'
  5192. `LOAD FILENAME, FILENAME, ... FILENAME'
  5193.      Include one or more object file FILENAME in the link; this has the
  5194.      same effect as specifying FILENAME directly on the `ld' command
  5195.      line.
  5196.  
  5197. `NAME OUTPUT-NAME'
  5198.      OUTPUT-NAME is the name for the program produced by `ld'; the
  5199.      MRI-compatible command `NAME' is equivalent to the command-line
  5200.      option `-o' or the general script language command `OUTPUT'.
  5201.  
  5202. `ORDER SECNAME, SECNAME, ... SECNAME'
  5203. `ORDER SECNAME SECNAME SECNAME'
  5204.      Normally, `ld' orders the sections in its output file in the order
  5205.      in which they first appear in the input files.  In an
  5206.      MRI-compatible script, you can override this ordering with the
  5207.      `ORDER' command.  The sections you list with `ORDER' will appear
  5208.      first in your output file, in the order specified.
  5209.  
  5210. `PUBLIC NAME=EXPRESSION'
  5211. `PUBLIC NAME,EXPRESSION'
  5212. `PUBLIC NAME EXPRESSION'
  5213.      Supply a value (EXPRESSION) for external symbol NAME used in the
  5214.      linker input files.
  5215.  
  5216. `SECT SECNAME, EXPRESSION'
  5217. `SECT SECNAME=EXPRESSION'
  5218. `SECT SECNAME EXPRESSION'
  5219.      You can use any of these three forms of the `SECT' command to
  5220.      specify the start address (EXPRESSION) for section SECNAME.  If
  5221.      you have more than one `SECT' statement for the same SECNAME, only
  5222.      the _first_ sets the start address.
  5223.  
  5224. 
  5225. File: ld.info,  Node: GNU Free Documentation License,  Next: Index,  Prev: MRI,  Up: Top
  5226.  
  5227. Appendix B GNU Free Documentation License
  5228. *****************************************
  5229.  
  5230.                         Version 1.1, March 2000
  5231.  
  5232.      Copyright (C) 2000, 2003 Free Software Foundation, Inc.
  5233.      59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  5234.  
  5235.      Everyone is permitted to copy and distribute verbatim copies
  5236.      of this license document, but changing it is not allowed.
  5237.  
  5238.  
  5239.   0. PREAMBLE
  5240.  
  5241.      The purpose of this License is to make a manual, textbook, or other
  5242.      written document "free" in the sense of freedom: to assure everyone
  5243.      the effective freedom to copy and redistribute it, with or without
  5244.      modifying it, either commercially or noncommercially.  Secondarily,
  5245.      this License preserves for the author and publisher a way to get
  5246.      credit for their work, while not being considered responsible for
  5247.      modifications made by others.
  5248.  
  5249.      This License is a kind of "copyleft", which means that derivative
  5250.      works of the document must themselves be free in the same sense.
  5251.      It complements the GNU General Public License, which is a copyleft
  5252.      license designed for free software.
  5253.  
  5254.      We have designed this License in order to use it for manuals for
  5255.      free software, because free software needs free documentation: a
  5256.      free program should come with manuals providing the same freedoms
  5257.      that the software does.  But this License is not limited to
  5258.      software manuals; it can be used for any textual work, regardless
  5259.      of subject matter or whether it is published as a printed book.
  5260.      We recommend this License principally for works whose purpose is
  5261.      instruction or reference.
  5262.  
  5263.  
  5264.   1. APPLICABILITY AND DEFINITIONS
  5265.  
  5266.      This License applies to any manual or other work that contains a
  5267.      notice placed by the copyright holder saying it can be distributed
  5268.      under the terms of this License.  The "Document", below, refers to
  5269.      any such manual or work.  Any member of the public is a licensee,
  5270.      and is addressed as "you."
  5271.  
  5272.      A "Modified Version" of the Document means any work containing the
  5273.      Document or a portion of it, either copied verbatim, or with
  5274.      modifications and/or translated into another language.
  5275.  
  5276.      A "Secondary Section" is a named appendix or a front-matter
  5277.      section of the Document that deals exclusively with the
  5278.      relationship of the publishers or authors of the Document to the
  5279.      Document's overall subject (or to related matters) and contains
  5280.      nothing that could fall directly within that overall subject.
  5281.      (For example, if the Document is in part a textbook of
  5282.      mathematics, a Secondary Section may not explain any mathematics.)
  5283.      The relationship could be a matter of historical connection with
  5284.      the subject or with related matters, or of legal, commercial,
  5285.      philosophical, ethical or political position regarding them.
  5286.  
  5287.      The "Invariant Sections" are certain Secondary Sections whose
  5288.      titles are designated, as being those of Invariant Sections, in
  5289.      the notice that says that the Document is released under this
  5290.      License.
  5291.  
  5292.      The "Cover Texts" are certain short passages of text that are
  5293.      listed, as Front-Cover Texts or Back-Cover Texts, in the notice
  5294.      that says that the Document is released under this License.
  5295.  
  5296.      A "Transparent" copy of the Document means a machine-readable copy,
  5297.      represented in a format whose specification is available to the
  5298.      general public, whose contents can be viewed and edited directly
  5299.      and straightforwardly with generic text editors or (for images
  5300.      composed of pixels) generic paint programs or (for drawings) some
  5301.      widely available drawing editor, and that is suitable for input to
  5302.      text formatters or for automatic translation to a variety of
  5303.      formats suitable for input to text formatters.  A copy made in an
  5304.      otherwise Transparent file format whose markup has been designed
  5305.      to thwart or discourage subsequent modification by readers is not
  5306.      Transparent.  A copy that is not "Transparent" is called "Opaque."
  5307.  
  5308.      Examples of suitable formats for Transparent copies include plain
  5309.      ASCII without markup, Texinfo input format, LaTeX input format,
  5310.      SGML or XML using a publicly available DTD, and
  5311.      standard-conforming simple HTML designed for human modification.
  5312.      Opaque formats include PostScript, PDF, proprietary formats that
  5313.      can be read and edited only by proprietary word processors, SGML
  5314.      or XML for which the DTD and/or processing tools are not generally
  5315.      available, and the machine-generated HTML produced by some word
  5316.      processors for output purposes only.
  5317.  
  5318.      The "Title Page" means, for a printed book, the title page itself,
  5319.      plus such following pages as are needed to hold, legibly, the
  5320.      material this License requires to appear in the title page.  For
  5321.      works in formats which do not have any title page as such, "Title
  5322.      Page" means the text near the most prominent appearance of the
  5323.      work's title, preceding the beginning of the body of the text.
  5324.  
  5325.   2. VERBATIM COPYING
  5326.  
  5327.      You may copy and distribute the Document in any medium, either
  5328.      commercially or noncommercially, provided that this License, the
  5329.      copyright notices, and the license notice saying this License
  5330.      applies to the Document are reproduced in all copies, and that you
  5331.      add no other conditions whatsoever to those of this License.  You
  5332.      may not use technical measures to obstruct or control the reading
  5333.      or further copying of the copies you make or distribute.  However,
  5334.      you may accept compensation in exchange for copies.  If you
  5335.      distribute a large enough number of copies you must also follow
  5336.      the conditions in section 3.
  5337.  
  5338.      You may also lend copies, under the same conditions stated above,
  5339.      and you may publicly display copies.
  5340.  
  5341.   3. COPYING IN QUANTITY
  5342.  
  5343.      If you publish printed copies of the Document numbering more than
  5344.      100, and the Document's license notice requires Cover Texts, you
  5345.      must enclose the copies in covers that carry, clearly and legibly,
  5346.      all these Cover Texts: Front-Cover Texts on the front cover, and
  5347.      Back-Cover Texts on the back cover.  Both covers must also clearly
  5348.      and legibly identify you as the publisher of these copies.  The
  5349.      front cover must present the full title with all words of the
  5350.      title equally prominent and visible.  You may add other material
  5351.      on the covers in addition.  Copying with changes limited to the
  5352.      covers, as long as they preserve the title of the Document and
  5353.      satisfy these conditions, can be treated as verbatim copying in
  5354.      other respects.
  5355.  
  5356.      If the required texts for either cover are too voluminous to fit
  5357.      legibly, you should put the first ones listed (as many as fit
  5358.      reasonably) on the actual cover, and continue the rest onto
  5359.      adjacent pages.
  5360.  
  5361.      If you publish or distribute Opaque copies of the Document
  5362.      numbering more than 100, you must either include a
  5363.      machine-readable Transparent copy along with each Opaque copy, or
  5364.      state in or with each Opaque copy a publicly-accessible
  5365.      computer-network location containing a complete Transparent copy
  5366.      of the Document, free of added material, which the general
  5367.      network-using public has access to download anonymously at no
  5368.      charge using public-standard network protocols.  If you use the
  5369.      latter option, you must take reasonably prudent steps, when you
  5370.      begin distribution of Opaque copies in quantity, to ensure that
  5371.      this Transparent copy will remain thus accessible at the stated
  5372.      location until at least one year after the last time you
  5373.      distribute an Opaque copy (directly or through your agents or
  5374.      retailers) of that edition to the public.
  5375.  
  5376.      It is requested, but not required, that you contact the authors of
  5377.      the Document well before redistributing any large number of
  5378.      copies, to give them a chance to provide you with an updated
  5379.      version of the Document.
  5380.  
  5381.   4. MODIFICATIONS
  5382.  
  5383.      You may copy and distribute a Modified Version of the Document
  5384.      under the conditions of sections 2 and 3 above, provided that you
  5385.      release the Modified Version under precisely this License, with
  5386.      the Modified Version filling the role of the Document, thus
  5387.      licensing distribution and modification of the Modified Version to
  5388.      whoever possesses a copy of it.  In addition, you must do these
  5389.      things in the Modified Version:
  5390.  
  5391.      A. Use in the Title Page (and on the covers, if any) a title
  5392.      distinct    from that of the Document, and from those of previous
  5393.      versions    (which should, if there were any, be listed in the
  5394.      History section    of the Document).  You may use the same title
  5395.      as a previous version    if the original publisher of that version
  5396.      gives permission.
  5397.      B. List on the Title Page, as authors, one or more persons or
  5398.      entities    responsible for authorship of the modifications in the
  5399.      Modified    Version, together with at least five of the principal
  5400.      authors of the    Document (all of its principal authors, if it
  5401.      has less than five).
  5402.      C. State on the Title page the name of the publisher of the
  5403.      Modified Version, as the publisher.
  5404.      D. Preserve all the copyright notices of the Document.
  5405.      E. Add an appropriate copyright notice for your modifications
  5406.      adjacent to the other copyright notices.
  5407.      F. Include, immediately after the copyright notices, a license
  5408.      notice    giving the public permission to use the Modified Version
  5409.      under the    terms of this License, in the form shown in the
  5410.      Addendum below.
  5411.      G. Preserve in that license notice the full lists of Invariant
  5412.      Sections    and required Cover Texts given in the Document's
  5413.      license notice.
  5414.      H. Include an unaltered copy of this License.
  5415.      I. Preserve the section entitled "History", and its title, and add
  5416.      to    it an item stating at least the title, year, new authors, and
  5417.        publisher of the Modified Version as given on the Title Page.
  5418.      If    there is no section entitled "History" in the Document,
  5419.      create one    stating the title, year, authors, and publisher of
  5420.      the Document as    given on its Title Page, then add an item
  5421.      describing the Modified    Version as stated in the previous
  5422.      sentence.
  5423.      J. Preserve the network location, if any, given in the Document for
  5424.        public access to a Transparent copy of the Document, and
  5425.      likewise    the network locations given in the Document for
  5426.      previous versions    it was based on.  These may be placed in the
  5427.      "History" section.     You may omit a network location for a work
  5428.      that was published at    least four years before the Document
  5429.      itself, or if the original    publisher of the version it refers
  5430.      to gives permission.
  5431.      K. In any section entitled "Acknowledgements" or "Dedications",
  5432.      preserve the section's title, and preserve in the section all the
  5433.       substance and tone of each of the contributor acknowledgements
  5434.      and/or dedications given therein.
  5435.      L. Preserve all the Invariant Sections of the Document,
  5436.      unaltered in their text and in their titles.  Section numbers
  5437.      or the equivalent are not considered part of the section titles.
  5438.      M. Delete any section entitled "Endorsements."  Such a section
  5439.      may not be included in the Modified Version.
  5440.      N. Do not retitle any existing section as "Endorsements"    or to
  5441.      conflict in title with any Invariant Section.
  5442.  
  5443.      If the Modified Version includes new front-matter sections or
  5444.      appendices that qualify as Secondary Sections and contain no
  5445.      material copied from the Document, you may at your option
  5446.      designate some or all of these sections as invariant.  To do this,
  5447.      add their titles to the list of Invariant Sections in the Modified
  5448.      Version's license notice.  These titles must be distinct from any
  5449.      other section titles.
  5450.  
  5451.      You may add a section entitled "Endorsements", provided it contains
  5452.      nothing but endorsements of your Modified Version by various
  5453.      parties-for example, statements of peer review or that the text has
  5454.      been approved by an organization as the authoritative definition
  5455.      of a standard.
  5456.  
  5457.      You may add a passage of up to five words as a Front-Cover Text,
  5458.      and a passage of up to 25 words as a Back-Cover Text, to the end
  5459.      of the list of Cover Texts in the Modified Version.  Only one
  5460.      passage of Front-Cover Text and one of Back-Cover Text may be
  5461.      added by (or through arrangements made by) any one entity.  If the
  5462.      Document already includes a cover text for the same cover,
  5463.      previously added by you or by arrangement made by the same entity
  5464.      you are acting on behalf of, you may not add another; but you may
  5465.      replace the old one, on explicit permission from the previous
  5466.      publisher that added the old one.
  5467.  
  5468.      The author(s) and publisher(s) of the Document do not by this
  5469.      License give permission to use their names for publicity for or to
  5470.      assert or imply endorsement of any Modified Version.
  5471.  
  5472.   5. COMBINING DOCUMENTS
  5473.  
  5474.      You may combine the Document with other documents released under
  5475.      this License, under the terms defined in section 4 above for
  5476.      modified versions, provided that you include in the combination
  5477.      all of the Invariant Sections of all of the original documents,
  5478.      unmodified, and list them all as Invariant Sections of your
  5479.      combined work in its license notice.
  5480.  
  5481.      The combined work need only contain one copy of this License, and
  5482.      multiple identical Invariant Sections may be replaced with a single
  5483.      copy.  If there are multiple Invariant Sections with the same name
  5484.      but different contents, make the title of each such section unique
  5485.      by adding at the end of it, in parentheses, the name of the
  5486.      original author or publisher of that section if known, or else a
  5487.      unique number.  Make the same adjustment to the section titles in
  5488.      the list of Invariant Sections in the license notice of the
  5489.      combined work.
  5490.  
  5491.      In the combination, you must combine any sections entitled
  5492.      "History" in the various original documents, forming one section
  5493.      entitled "History"; likewise combine any sections entitled
  5494.      "Acknowledgements", and any sections entitled "Dedications."  You
  5495.      must delete all sections entitled "Endorsements."
  5496.  
  5497.   6. COLLECTIONS OF DOCUMENTS
  5498.  
  5499.      You may make a collection consisting of the Document and other
  5500.      documents released under this License, and replace the individual
  5501.      copies of this License in the various documents with a single copy
  5502.      that is included in the collection, provided that you follow the
  5503.      rules of this License for verbatim copying of each of the
  5504.      documents in all other respects.
  5505.  
  5506.      You may extract a single document from such a collection, and
  5507.      distribute it individually under this License, provided you insert
  5508.      a copy of this License into the extracted document, and follow
  5509.      this License in all other respects regarding verbatim copying of
  5510.      that document.
  5511.  
  5512.   7. AGGREGATION WITH INDEPENDENT WORKS
  5513.  
  5514.      A compilation of the Document or its derivatives with other
  5515.      separate and independent documents or works, in or on a volume of
  5516.      a storage or distribution medium, does not as a whole count as a
  5517.      Modified Version of the Document, provided no compilation
  5518.      copyright is claimed for the compilation.  Such a compilation is
  5519.      called an "aggregate", and this License does not apply to the
  5520.      other self-contained works thus compiled with the Document, on
  5521.      account of their being thus compiled, if they are not themselves
  5522.      derivative works of the Document.
  5523.  
  5524.      If the Cover Text requirement of section 3 is applicable to these
  5525.      copies of the Document, then if the Document is less than one
  5526.      quarter of the entire aggregate, the Document's Cover Texts may be
  5527.      placed on covers that surround only the Document within the
  5528.      aggregate.  Otherwise they must appear on covers around the whole
  5529.      aggregate.
  5530.  
  5531.   8. TRANSLATION
  5532.  
  5533.      Translation is considered a kind of modification, so you may
  5534.      distribute translations of the Document under the terms of section
  5535.      4.  Replacing Invariant Sections with translations requires special
  5536.      permission from their copyright holders, but you may include
  5537.      translations of some or all Invariant Sections in addition to the
  5538.      original versions of these Invariant Sections.  You may include a
  5539.      translation of this License provided that you also include the
  5540.      original English version of this License.  In case of a
  5541.      disagreement between the translation and the original English
  5542.      version of this License, the original English version will prevail.
  5543.  
  5544.   9. TERMINATION
  5545.  
  5546.      You may not copy, modify, sublicense, or distribute the Document
  5547.      except as expressly provided for under this License.  Any other
  5548.      attempt to copy, modify, sublicense or distribute the Document is
  5549.      void, and will automatically terminate your rights under this
  5550.      License.  However, parties who have received copies, or rights,
  5551.      from you under this License will not have their licenses
  5552.      terminated so long as such parties remain in full compliance.
  5553.  
  5554.  10. FUTURE REVISIONS OF THIS LICENSE
  5555.  
  5556.      The Free Software Foundation may publish new, revised versions of
  5557.      the GNU Free Documentation License from time to time.  Such new
  5558.      versions will be similar in spirit to the present version, but may
  5559.      differ in detail to address new problems or concerns.  See
  5560.      http://www.gnu.org/copyleft/.
  5561.  
  5562.      Each version of the License is given a distinguishing version
  5563.      number.  If the Document specifies that a particular numbered
  5564.      version of this License "or any later version" applies to it, you
  5565.      have the option of following the terms and conditions either of
  5566.      that specified version or of any later version that has been
  5567.      published (not as a draft) by the Free Software Foundation.  If
  5568.      the Document does not specify a version number of this License,
  5569.      you may choose any version ever published (not as a draft) by the
  5570.      Free Software Foundation.
  5571.  
  5572.  
  5573. ADDENDUM: How to use this License for your documents
  5574. ====================================================
  5575.  
  5576. To use this License in a document you have written, include a copy of
  5577. the License in the document and put the following copyright and license
  5578. notices just after the title page:
  5579.  
  5580.      Copyright (C)  YEAR  YOUR NAME.
  5581.      Permission is granted to copy, distribute and/or modify this document
  5582.      under the terms of the GNU Free Documentation License, Version 1.1
  5583.      or any later version published by the Free Software Foundation;
  5584.      with the Invariant Sections being LIST THEIR TITLES, with the
  5585.      Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST.
  5586.      A copy of the license is included in the section entitled "GNU
  5587.      Free Documentation License."
  5588.  
  5589.    If you have no Invariant Sections, write "with no Invariant Sections"
  5590. instead of saying which ones are invariant.  If you have no Front-Cover
  5591. Texts, write "no Front-Cover Texts" instead of "Front-Cover Texts being
  5592. LIST"; likewise for Back-Cover Texts.
  5593.  
  5594.    If your document contains nontrivial examples of program code, we
  5595. recommend releasing these examples in parallel under your choice of
  5596. free software license, such as the GNU General Public License, to
  5597. permit their use in free software.
  5598.  
  5599. 
  5600. File: ld.info,  Node: Index,  Prev: GNU Free Documentation License,  Up: Top
  5601.  
  5602. Index
  5603. *****
  5604.  
  5605. [index]
  5606. * Menu:
  5607.  
  5608. * ":                                     Symbols.            (line    6)
  5609. * -(:                                    Options.            (line  553)
  5610. * --accept-unknown-input-arch:           Options.            (line  571)
  5611. * --add-needed:                          Options.            (line  593)
  5612. * --add-stdcall-alias:                   Options.            (line 1279)
  5613. * --allow-multiple-definition:           Options.            (line  759)
  5614. * --allow-shlib-undefined:               Options.            (line  765)
  5615. * --architecture=ARCH:                   Options.            (line   90)
  5616. * --as-needed:                           Options.            (line  581)
  5617. * --auxiliary:                           Options.            (line  191)
  5618. * --base-file:                           Options.            (line 1284)
  5619. * --be8:                                 ARM.                (line   23)
  5620. * --check-sections:                      Options.            (line  641)
  5621. * --cref:                                Options.            (line  651)
  5622. * --default-imported-symver:             Options.            (line  793)
  5623. * --default-symver:                      Options.            (line  789)
  5624. * --defsym SYMBOL=EXP:                   Options.            (line  679)
  5625. * --demangle[=STYLE]:                    Options.            (line  692)
  5626. * --disable-auto-image-base:             Options.            (line 1431)
  5627. * --disable-auto-import:                 Options.            (line 1560)
  5628. * --disable-new-dtags:                   Options.            (line 1230)
  5629. * --disable-runtime-pseudo-reloc:        Options.            (line 1573)
  5630. * --disable-stdcall-fixup:               Options.            (line 1294)
  5631. * --discard-all:                         Options.            (line  470)
  5632. * --discard-locals:                      Options.            (line  474)
  5633. * --dll:                                 Options.            (line 1289)
  5634. * --dll-search-prefix:                   Options.            (line 1437)
  5635. * --dynamic-linker FILE:                 Options.            (line  705)
  5636. * --emit-relocs:                         Options.            (line  376)
  5637. * --enable-auto-image-base:              Options.            (line 1423)
  5638. * --enable-auto-import:                  Options.            (line 1446)
  5639. * --enable-extra-pe-debug:               Options.            (line 1578)
  5640. * --enable-new-dtags:                    Options.            (line 1230)
  5641. * --enable-runtime-pseudo-reloc:         Options.            (line 1565)
  5642. * --enable-stdcall-fixup:                Options.            (line 1294)
  5643. * --entry=ENTRY:                         Options.            (line  144)
  5644. * --error-unresolved-symbols:            Options.            (line 1183)
  5645. * --exclude-libs:                        Options.            (line  154)
  5646. * --exclude-symbols:                     Options.            (line 1336)
  5647. * --export-all-symbols:                  Options.            (line 1312)
  5648. * --export-dynamic:                      Options.            (line  165)
  5649. * --fatal-warnings:                      Options.            (line  711)
  5650. * --file-alignment:                      Options.            (line 1342)
  5651. * --filter:                              Options.            (line  212)
  5652. * --fix-v4bx:                            ARM.                (line   44)
  5653. * --force-exe-suffix:                    Options.            (line  714)
  5654. * --format=FORMAT:                       Options.            (line  101)
  5655. * --format=VERSION:                      TI COFF.            (line    6)
  5656. * --gc-sections:                         Options.            (line  724)
  5657. * --gpsize:                              Options.            (line  245)
  5658. * --hash-size=NUMBER:                    Options.            (line 1239)
  5659. * --heap:                                Options.            (line 1348)
  5660. * --help:                                Options.            (line  732)
  5661. * --image-base:                          Options.            (line 1355)
  5662. * --just-symbols=FILE:                   Options.            (line  404)
  5663. * --kill-at:                             Options.            (line 1364)
  5664. * --large-address-aware:                 Options.            (line 1369)
  5665. * --library-path=DIR:                    Options.            (line  301)
  5666. * --library=ARCHIVE:                     Options.            (line  271)
  5667. * --major-image-version:                 Options.            (line 1378)
  5668. * --major-os-version:                    Options.            (line 1383)
  5669. * --major-subsystem-version:             Options.            (line 1387)
  5670. * --minor-image-version:                 Options.            (line 1392)
  5671. * --minor-os-version:                    Options.            (line 1397)
  5672. * --minor-subsystem-version:             Options.            (line 1401)
  5673. * --mri-script=MRI-CMDFILE:              Options.            (line  125)
  5674. * --multi-subspace:                      HPPA ELF32.         (line    6)
  5675. * --nmagic:                              Options.            (line  345)
  5676. * --no-accept-unknown-input-arch:        Options.            (line  571)
  5677. * --no-add-needed:                       Options.            (line  593)
  5678. * --no-allow-shlib-undefined:            Options.            (line  765)
  5679. * --no-as-needed:                        Options.            (line  581)
  5680. * --no-check-sections:                   Options.            (line  641)
  5681. * --no-define-common:                    Options.            (line  663)
  5682. * --no-demangle:                         Options.            (line  692)
  5683. * --no-gc-sections:                      Options.            (line  724)
  5684. * --no-keep-memory:                      Options.            (line  744)
  5685. * --no-omagic:                           Options.            (line  359)
  5686. * --no-relax:                            Xtensa.             (line   56)
  5687. * --no-undefined:                        Options.            (line  751)
  5688. * --no-undefined-version:                Options.            (line  784)
  5689. * --no-warn-mismatch:                    Options.            (line  797)
  5690. * --no-whole-archive:                    Options.            (line  806)
  5691. * --noinhibit-exec:                      Options.            (line  810)
  5692. * --oformat:                             Options.            (line  822)
  5693. * --omagic:                              Options.            (line  350)
  5694. * --out-implib:                          Options.            (line 1414)
  5695. * --output-def:                          Options.            (line 1406)
  5696. * --output=OUTPUT:                       Options.            (line  365)
  5697. * --pic-executable:                      Options.            (line  835)
  5698. * --print-map:                           Options.            (line  333)
  5699. * --reduce-memory-overheads:             Options.            (line 1247)
  5700. * --relax:                               Options.            (line  851)
  5701. * --relax on i960:                       i960.               (line   31)
  5702. * --relax on Xtensa:                     Xtensa.             (line   27)
  5703. * --relocatable:                         Options.            (line  385)
  5704. * --script=SCRIPT:                       Options.            (line  428)
  5705. * --section-alignment:                   Options.            (line 1583)
  5706. * --section-start SECTIONNAME=ORG:       Options.            (line 1020)
  5707. * --sort-common:                         Options.            (line  967)
  5708. * --sort-section alignment:              Options.            (line  977)
  5709. * --sort-section name:                   Options.            (line  973)
  5710. * --split-by-file:                       Options.            (line  981)
  5711. * --split-by-reloc:                      Options.            (line  986)
  5712. * --stack:                               Options.            (line 1589)
  5713. * --stats:                               Options.            (line  999)
  5714. * --strip-all:                           Options.            (line  415)
  5715. * --strip-debug:                         Options.            (line  419)
  5716. * --stub-group-size=N:                   HPPA ELF32.         (line   12)
  5717. * --subsystem:                           Options.            (line 1596)
  5718. * --support-old-code:                    ARM.                (line    6)
  5719. * --sysroot:                             Options.            (line 1003)
  5720. * --target-help:                         Options.            (line  736)
  5721. * --target1-abs:                         ARM.                (line   27)
  5722. * --target1-rel:                         ARM.                (line   27)
  5723. * --target2=TYPE:                        ARM.                (line   32)
  5724. * --thumb-entry=ENTRY:                   ARM.                (line   17)
  5725. * --trace:                               Options.            (line  424)
  5726. * --trace-symbol=SYMBOL:                 Options.            (line  479)
  5727. * --traditional-format:                  Options.            (line 1008)
  5728. * --undefined=SYMBOL:                    Options.            (line  437)
  5729. * --unique[=SECTION]:                    Options.            (line  455)
  5730. * --unresolved-symbols:                  Options.            (line 1035)
  5731. * --verbose:                             Options.            (line 1064)
  5732. * --version:                             Options.            (line  464)
  5733. * --version-script=VERSION-SCRIPTFILE:   Options.            (line 1070)
  5734. * --warn-common:                         Options.            (line 1077)
  5735. * --warn-constructors:                   Options.            (line 1145)
  5736. * --warn-multiple-gp:                    Options.            (line 1150)
  5737. * --warn-once:                           Options.            (line 1164)
  5738. * --warn-section-align:                  Options.            (line 1168)
  5739. * --warn-shared-textrel:                 Options.            (line 1175)
  5740. * --warn-unresolved-symbols:             Options.            (line 1178)
  5741. * --whole-archive:                       Options.            (line 1187)
  5742. * --wrap:                                Options.            (line 1201)
  5743. * -AARCH:                                Options.            (line   89)
  5744. * -aKEYWORD:                             Options.            (line   82)
  5745. * -assert KEYWORD:                       Options.            (line  603)
  5746. * -b FORMAT:                             Options.            (line  101)
  5747. * -Bdynamic:                             Options.            (line  606)
  5748. * -Bgroup:                               Options.            (line  616)
  5749. * -Bshareable:                           Options.            (line  959)
  5750. * -Bstatic:                              Options.            (line  623)
  5751. * -Bsymbolic:                            Options.            (line  634)
  5752. * -c MRI-CMDFILE:                        Options.            (line  125)
  5753. * -call_shared:                          Options.            (line  606)
  5754. * -d:                                    Options.            (line  135)
  5755. * -dc:                                   Options.            (line  135)
  5756. * -dn:                                   Options.            (line  623)
  5757. * -dp:                                   Options.            (line  135)
  5758. * -dy:                                   Options.            (line  606)
  5759. * -E:                                    Options.            (line  165)
  5760. * -e ENTRY:                              Options.            (line  144)
  5761. * -EB:                                   Options.            (line  184)
  5762. * -EL:                                   Options.            (line  187)
  5763. * -F:                                    Options.            (line  212)
  5764. * -f:                                    Options.            (line  191)
  5765. * -fini:                                 Options.            (line  236)
  5766. * -G:                                    Options.            (line  245)
  5767. * -g:                                    Options.            (line  242)
  5768. * -hNAME:                                Options.            (line  253)
  5769. * -i:                                    Options.            (line  262)
  5770. * -IFILE:                                Options.            (line  705)
  5771. * -init:                                 Options.            (line  265)
  5772. * -lARCHIVE:                             Options.            (line  271)
  5773. * -LDIR:                                 Options.            (line  301)
  5774. * -M:                                    Options.            (line  333)
  5775. * -m EMULATION:                          Options.            (line  323)
  5776. * -Map:                                  Options.            (line  740)
  5777. * -N:                                    Options.            (line  350)
  5778. * -n:                                    Options.            (line  345)
  5779. * -non_shared:                           Options.            (line  623)
  5780. * -nostdlib:                             Options.            (line  816)
  5781. * -O LEVEL:                              Options.            (line  371)
  5782. * -o OUTPUT:                             Options.            (line  365)
  5783. * -pie:                                  Options.            (line  835)
  5784. * -q:                                    Options.            (line  376)
  5785. * -qmagic:                               Options.            (line  845)
  5786. * -Qy:                                   Options.            (line  848)
  5787. * -r:                                    Options.            (line  385)
  5788. * -R FILE:                               Options.            (line  404)
  5789. * -rpath:                                Options.            (line  884)
  5790. * -rpath-link:                           Options.            (line  906)
  5791. * -S:                                    Options.            (line  419)
  5792. * -s:                                    Options.            (line  415)
  5793. * -shared:                               Options.            (line  959)
  5794. * -soname=NAME:                          Options.            (line  253)
  5795. * -static:                               Options.            (line  623)
  5796. * -t:                                    Options.            (line  424)
  5797. * -T SCRIPT:                             Options.            (line  428)
  5798. * -Tbss ORG:                             Options.            (line 1029)
  5799. * -Tdata ORG:                            Options.            (line 1029)
  5800. * -Ttext ORG:                            Options.            (line 1029)
  5801. * -u SYMBOL:                             Options.            (line  437)
  5802. * -Ur:                                   Options.            (line  445)
  5803. * -V:                                    Options.            (line  464)
  5804. * -v:                                    Options.            (line  464)
  5805. * -X:                                    Options.            (line  474)
  5806. * -x:                                    Options.            (line  470)
  5807. * -Y PATH:                               Options.            (line  488)
  5808. * -y SYMBOL:                             Options.            (line  479)
  5809. * -z defs:                               Options.            (line  751)
  5810. * -z KEYWORD:                            Options.            (line  492)
  5811. * -z muldefs:                            Options.            (line  759)
  5812. * .:                                     Location Counter.   (line    6)
  5813. * /DISCARD/:                             Output Section Discarding.
  5814.                                                              (line   18)
  5815. * :PHDR:                                 Output Section Phdr.
  5816.                                                              (line    6)
  5817. * =FILLEXP:                              Output Section Fill.
  5818.                                                              (line    6)
  5819. * >REGION:                               Output Section Region.
  5820.                                                              (line    6)
  5821. * [COMMON]:                              Input Section Common.
  5822.                                                              (line   29)
  5823. * ABSOLUTE (MRI):                        MRI.                (line   33)
  5824. * absolute and relocatable symbols:      Expression Section. (line    6)
  5825. * absolute expressions:                  Expression Section. (line    6)
  5826. * ABSOLUTE(EXP):                         Builtin Functions.  (line   10)
  5827. * ADDR(SECTION):                         Builtin Functions.  (line   17)
  5828. * address, section:                      Output Section Address.
  5829.                                                              (line    6)
  5830. * ALIAS (MRI):                           MRI.                (line   44)
  5831. * ALIGN (MRI):                           MRI.                (line   50)
  5832. * align expression:                      Builtin Functions.  (line   36)
  5833. * align location counter:                Builtin Functions.  (line   36)
  5834. * ALIGN(ALIGN):                          Builtin Functions.  (line   36)
  5835. * ALIGN(EXP,ALIGN):                      Builtin Functions.  (line   36)
  5836. * allocating memory:                     MEMORY.             (line    6)
  5837. * architecture:                          Miscellaneous Commands.
  5838.                                                              (line   46)
  5839. * architectures:                         Options.            (line   89)
  5840. * archive files, from cmd line:          Options.            (line  271)
  5841. * archive search path in linker script:  File Commands.      (line   71)
  5842. * arithmetic:                            Expressions.        (line    6)
  5843. * arithmetic operators:                  Operators.          (line    6)
  5844. * ARM interworking support:              ARM.                (line    6)
  5845. * AS_NEEDED(FILES):                      File Commands.      (line   51)
  5846. * ASSERT:                                Miscellaneous Commands.
  5847.                                                              (line    9)
  5848. * assertion in linker script:            Miscellaneous Commands.
  5849.                                                              (line    9)
  5850. * assignment in scripts:                 Assignments.        (line    6)
  5851. * AT(LMA):                               Output Section LMA. (line    6)
  5852. * AT>LMA_REGION:                         Output Section LMA. (line    6)
  5853. * automatic data imports:                WIN32.              (line  102)
  5854. * back end:                              BFD.                (line    6)
  5855. * BASE (MRI):                            MRI.                (line   54)
  5856. * BE8:                                   ARM.                (line   23)
  5857. * BFD canonical format:                  Canonical format.   (line   11)
  5858. * BFD requirements:                      BFD.                (line   16)
  5859. * big-endian objects:                    Options.            (line  184)
  5860. * binary input format:                   Options.            (line  101)
  5861. * BLOCK(EXP):                            Builtin Functions.  (line   62)
  5862. * bug criteria:                          Bug Criteria.       (line    6)
  5863. * bug reports:                           Bug Reporting.      (line    6)
  5864. * bugs in ld:                            Reporting Bugs.     (line    6)
  5865. * BYTE(EXPRESSION):                      Output Section Data.
  5866.                                                              (line    6)
  5867. * C++ constructors, arranging in link:   Output Section Keywords.
  5868.                                                              (line   19)
  5869. * CHIP (MRI):                            MRI.                (line   58)
  5870. * COLLECT_NO_DEMANGLE:                   Environment.        (line   29)
  5871. * combining symbols, warnings on:        Options.            (line 1077)
  5872. * command files:                         Scripts.            (line    6)
  5873. * command line:                          Options.            (line    6)
  5874. * common allocation:                     Options.            (line  135)
  5875. * common allocation in linker script:    Miscellaneous Commands.
  5876.                                                              (line   20)
  5877. * common symbol placement:               Input Section Common.
  5878.                                                              (line    6)
  5879. * compatibility, MRI:                    Options.            (line  125)
  5880. * constants in linker scripts:           Constants.          (line    6)
  5881. * CONSTRUCTORS:                          Output Section Keywords.
  5882.                                                              (line   19)
  5883. * constructors:                          Options.            (line  445)
  5884. * constructors, arranging in link:       Output Section Keywords.
  5885.                                                              (line   19)
  5886. * crash of linker:                       Bug Criteria.       (line    9)
  5887. * CREATE_OBJECT_SYMBOLS:                 Output Section Keywords.
  5888.                                                              (line    9)
  5889. * creating a DEF file:                   WIN32.              (line   69)
  5890. * cross reference table:                 Options.            (line  651)
  5891. * cross references:                      Miscellaneous Commands.
  5892.                                                              (line   30)
  5893. * current output location:               Location Counter.   (line    6)
  5894. * data:                                  Output Section Data.
  5895.                                                              (line    6)
  5896. * DATA_SEGMENT_ALIGN(MAXPAGESIZE, COMMONPAGESIZE): Builtin Functions.
  5897.                                                              (line   67)
  5898. * DATA_SEGMENT_END(EXP):                 Builtin Functions.  (line   88)
  5899. * DATA_SEGMENT_RELRO_END(OFFSET, EXP):   Builtin Functions.  (line   94)
  5900. * dbx:                                   Options.            (line 1013)
  5901. * DEF files, creating:                   Options.            (line 1406)
  5902. * default emulation:                     Environment.        (line   21)
  5903. * default input format:                  Environment.        (line    9)
  5904. * DEFINED(SYMBOL):                       Builtin Functions.  (line  105)
  5905. * deleting local symbols:                Options.            (line  470)
  5906. * demangling, default:                   Environment.        (line   29)
  5907. * demangling, from command line:         Options.            (line  692)
  5908. * direct linking to a dll:               WIN32.              (line  150)
  5909. * discarding sections:                   Output Section Discarding.
  5910.                                                              (line    6)
  5911. * discontinuous memory:                  MEMORY.             (line    6)
  5912. * DLLs, creating:                        Options.            (line 1312)
  5913. * DLLs, linking to:                      Options.            (line 1437)
  5914. * dot:                                   Location Counter.   (line    6)
  5915. * dot inside sections:                   Location Counter.   (line   34)
  5916. * dot outside sections:                  Location Counter.   (line   64)
  5917. * dynamic linker, from command line:     Options.            (line  705)
  5918. * dynamic symbol table:                  Options.            (line  165)
  5919. * ELF program headers:                   PHDRS.              (line    6)
  5920. * emulation:                             Options.            (line  323)
  5921. * emulation, default:                    Environment.        (line   21)
  5922. * END (MRI):                             MRI.                (line   62)
  5923. * endianness:                            Options.            (line  184)
  5924. * entry point:                           Entry Point.        (line    6)
  5925. * entry point, from command line:        Options.            (line  144)
  5926. * entry point, thumb:                    ARM.                (line   17)
  5927. * ENTRY(SYMBOL):                         Entry Point.        (line    6)
  5928. * error on valid input:                  Bug Criteria.       (line   12)
  5929. * example of linker script:              Simple Example.     (line    6)
  5930. * exporting DLL symbols:                 WIN32.              (line   19)
  5931. * expression evaluation order:           Evaluation.         (line    6)
  5932. * expression sections:                   Expression Section. (line    6)
  5933. * expression, absolute:                  Builtin Functions.  (line   10)
  5934. * expressions:                           Expressions.        (line    6)
  5935. * EXTERN:                                Miscellaneous Commands.
  5936.                                                              (line   13)
  5937. * fatal signal:                          Bug Criteria.       (line    9)
  5938. * file name wildcard patterns:           Input Section Wildcards.
  5939.                                                              (line    6)
  5940. * FILEHDR:                               PHDRS.              (line   61)
  5941. * filename symbols:                      Output Section Keywords.
  5942.                                                              (line    9)
  5943. * fill pattern, entire section:          Output Section Fill.
  5944.                                                              (line    6)
  5945. * FILL(EXPRESSION):                      Output Section Data.
  5946.                                                              (line   39)
  5947. * finalization function:                 Options.            (line  236)
  5948. * first input file:                      File Commands.      (line   79)
  5949. * first instruction:                     Entry Point.        (line    6)
  5950. * FIX_V4BX:                              ARM.                (line   44)
  5951. * FORCE_COMMON_ALLOCATION:               Miscellaneous Commands.
  5952.                                                              (line   20)
  5953. * forcing input section alignment:       Forced Input Alignment.
  5954.                                                              (line    6)
  5955. * FORMAT (MRI):                          MRI.                (line   66)
  5956. * functions in expressions:              Builtin Functions.  (line    6)
  5957. * garbage collection <1>:                Input Section Keep. (line    6)
  5958. * garbage collection:                    Options.            (line  724)
  5959. * generating optimized output:           Options.            (line  371)
  5960. * GNU linker:                            Overview.           (line    6)
  5961. * GNUTARGET:                             Environment.        (line    9)
  5962. * GROUP(FILES):                          File Commands.      (line   44)
  5963. * grouping input files:                  File Commands.      (line   44)
  5964. * groups of archives:                    Options.            (line  553)
  5965. * H8/300 support:                        H8/300.             (line    6)
  5966. * header size:                           Builtin Functions.  (line  170)
  5967. * heap size:                             Options.            (line 1348)
  5968. * help:                                  Options.            (line  732)
  5969. * holes:                                 Location Counter.   (line   12)
  5970. * holes, filling:                        Output Section Data.
  5971.                                                              (line   39)
  5972. * HPPA multiple sub-space stubs:         HPPA ELF32.         (line    6)
  5973. * HPPA stub grouping:                    HPPA ELF32.         (line   12)
  5974. * i960 support:                          i960.               (line    6)
  5975. * image base:                            Options.            (line 1355)
  5976. * implicit linker scripts:               Implicit Linker Scripts.
  5977.                                                              (line    6)
  5978. * import libraries:                      WIN32.              (line   10)
  5979. * INCLUDE FILENAME:                      File Commands.      (line    9)
  5980. * including a linker script:             File Commands.      (line    9)
  5981. * including an entire archive:           Options.            (line 1187)
  5982. * incremental link:                      Options.            (line  262)
  5983. * INHIBIT_COMMON_ALLOCATION:             Miscellaneous Commands.
  5984.                                                              (line   25)
  5985. * initialization function:               Options.            (line  265)
  5986. * initialized data in ROM:               Output Section LMA. (line   21)
  5987. * input file format in linker script:    Format Commands.    (line   35)
  5988. * input filename symbols:                Output Section Keywords.
  5989.                                                              (line    9)
  5990. * input files in linker scripts:         File Commands.      (line   16)
  5991. * input files, displaying:               Options.            (line  424)
  5992. * input format:                          Options.            (line  101)
  5993. * input object files in linker scripts:  File Commands.      (line   16)
  5994. * input section alignment:               Forced Input Alignment.
  5995.                                                              (line    6)
  5996. * input section basics:                  Input Section Basics.
  5997.                                                              (line    6)
  5998. * input section wildcards:               Input Section Wildcards.
  5999.                                                              (line    6)
  6000. * input sections:                        Input Section.      (line    6)
  6001. * INPUT(FILES):                          File Commands.      (line   16)
  6002. * integer notation:                      Constants.          (line    6)
  6003. * integer suffixes:                      Constants.          (line   12)
  6004. * internal object-file format:           Canonical format.   (line   11)
  6005. * invalid input:                         Bug Criteria.       (line   14)
  6006. * K and M integer suffixes:              Constants.          (line   12)
  6007. * KEEP:                                  Input Section Keep. (line    6)
  6008. * l =:                                   MEMORY.             (line   72)
  6009. * L, deleting symbols beginning:         Options.            (line  474)
  6010. * lazy evaluation:                       Evaluation.         (line    6)
  6011. * ld bugs, reporting:                    Bug Reporting.      (line    6)
  6012. * LDEMULATION:                           Environment.        (line   21)
  6013. * len =:                                 MEMORY.             (line   72)
  6014. * LENGTH =:                              MEMORY.             (line   72)
  6015. * LENGTH(MEMORY):                        Builtin Functions.  (line  122)
  6016. * library search path in linker script:  File Commands.      (line   71)
  6017. * link map:                              Options.            (line  333)
  6018. * link-time runtime library search path: Options.            (line  906)
  6019. * linker crash:                          Bug Criteria.       (line    9)
  6020. * linker script concepts:                Basic Script Concepts.
  6021.                                                              (line    6)
  6022. * linker script example:                 Simple Example.     (line    6)
  6023. * linker script file commands:           File Commands.      (line    6)
  6024. * linker script format:                  Script Format.      (line    6)
  6025. * linker script input object files:      File Commands.      (line   16)
  6026. * linker script simple commands:         Simple Commands.    (line    6)
  6027. * linker scripts:                        Scripts.            (line    6)
  6028. * LIST (MRI):                            MRI.                (line   77)
  6029. * little-endian objects:                 Options.            (line  187)
  6030. * LOAD (MRI):                            MRI.                (line   84)
  6031. * load address:                          Output Section LMA. (line    6)
  6032. * LOADADDR(SECTION):                     Builtin Functions.  (line  125)
  6033. * loading, preventing:                   Output Section Type.
  6034.                                                              (line   22)
  6035. * local symbols, deleting:               Options.            (line  474)
  6036. * location counter:                      Location Counter.   (line    6)
  6037. * LONG(EXPRESSION):                      Output Section Data.
  6038.                                                              (line    6)
  6039. * M and K integer suffixes:              Constants.          (line   12)
  6040. * machine architecture:                  Miscellaneous Commands.
  6041.                                                              (line   46)
  6042. * machine dependencies:                  Machine Dependent.  (line    6)
  6043. * mapping input sections to output sections: Input Section.  (line    6)
  6044. * MAX:                                   Builtin Functions.  (line  130)
  6045. * MEMORY:                                MEMORY.             (line    6)
  6046. * memory region attributes:              MEMORY.             (line   32)
  6047. * memory regions:                        MEMORY.             (line    6)
  6048. * memory regions and sections:           Output Section Region.
  6049.                                                              (line    6)
  6050. * memory usage:                          Options.            (line  744)
  6051. * MIN:                                   Builtin Functions.  (line  133)
  6052. * MRI compatibility:                     MRI.                (line    6)
  6053. * MSP430 extra sections:                 MSP430.             (line   11)
  6054. * NAME (MRI):                            MRI.                (line   90)
  6055. * name, section:                         Output Section Name.
  6056.                                                              (line    6)
  6057. * names:                                 Symbols.            (line    6)
  6058. * naming the output file:                Options.            (line  365)
  6059. * NEXT(EXP):                             Builtin Functions.  (line  137)
  6060. * NMAGIC:                                Options.            (line  345)
  6061. * NOCROSSREFS(SECTIONS):                 Miscellaneous Commands.
  6062.                                                              (line   30)
  6063. * NOLOAD:                                Output Section Type.
  6064.                                                              (line   22)
  6065. * not enough room for program headers:   Builtin Functions.  (line  175)
  6066. * o =:                                   MEMORY.             (line   67)
  6067. * objdump -i:                            BFD.                (line    6)
  6068. * object file management:                BFD.                (line    6)
  6069. * object files:                          Options.            (line   29)
  6070. * object formats available:              BFD.                (line    6)
  6071. * object size:                           Options.            (line  245)
  6072. * OMAGIC:                                Options.            (line  350)
  6073. * opening object files:                  BFD outline.        (line    6)
  6074. * operators for arithmetic:              Operators.          (line    6)
  6075. * options:                               Options.            (line    6)
  6076. * ORDER (MRI):                           MRI.                (line   95)
  6077. * org =:                                 MEMORY.             (line   67)
  6078. * ORIGIN =:                              MEMORY.             (line   67)
  6079. * ORIGIN(MEMORY):                        Builtin Functions.  (line  143)
  6080. * output file after errors:              Options.            (line  810)
  6081. * output file format in linker script:   Format Commands.    (line   10)
  6082. * output file name in linker scripot:    File Commands.      (line   61)
  6083. * output section attributes:             Output Section Attributes.
  6084.                                                              (line    6)
  6085. * output section data:                   Output Section Data.
  6086.                                                              (line    6)
  6087. * OUTPUT(FILENAME):                      File Commands.      (line   61)
  6088. * OUTPUT_ARCH(BFDARCH):                  Miscellaneous Commands.
  6089.                                                              (line   46)
  6090. * OUTPUT_FORMAT(BFDNAME):                Format Commands.    (line   10)
  6091. * OVERLAY:                               Overlay Description.
  6092.                                                              (line    6)
  6093. * overlays:                              Overlay Description.
  6094.                                                              (line    6)
  6095. * partial link:                          Options.            (line  385)
  6096. * PHDRS:                                 PHDRS.              (line    6)
  6097. * position independent executables:      Options.            (line  837)
  6098. * precedence in expressions:             Operators.          (line    6)
  6099. * prevent unnecessary loading:           Output Section Type.
  6100.                                                              (line   22)
  6101. * program headers:                       PHDRS.              (line    6)
  6102. * program headers and sections:          Output Section Phdr.
  6103.                                                              (line    6)
  6104. * program headers, not enough room:      Builtin Functions.  (line  175)
  6105. * program segments:                      PHDRS.              (line    6)
  6106. * PROVIDE:                               PROVIDE.            (line    6)
  6107. * PUBLIC (MRI):                          MRI.                (line  103)
  6108. * QUAD(EXPRESSION):                      Output Section Data.
  6109.                                                              (line    6)
  6110. * quoted symbol names:                   Symbols.            (line    6)
  6111. * read-only text:                        Options.            (line  345)
  6112. * read/write from cmd line:              Options.            (line  350)
  6113. * regions of memory:                     MEMORY.             (line    6)
  6114. * relative expressions:                  Expression Section. (line    6)
  6115. * relaxing addressing modes:             Options.            (line  851)
  6116. * relaxing on H8/300:                    H8/300.             (line    9)
  6117. * relaxing on i960:                      i960.               (line   31)
  6118. * relaxing on Xtensa:                    Xtensa.             (line   27)
  6119. * relocatable and absolute symbols:      Expression Section. (line    6)
  6120. * relocatable output:                    Options.            (line  385)
  6121. * removing sections:                     Output Section Discarding.
  6122.                                                              (line    6)
  6123. * reporting bugs in ld:                  Reporting Bugs.     (line    6)
  6124. * requirements for BFD:                  BFD.                (line   16)
  6125. * retain relocations in final executable: Options.           (line  376)
  6126. * retaining specified symbols:           Options.            (line  870)
  6127. * ROM initialized data:                  Output Section LMA. (line   21)
  6128. * round up expression:                   Builtin Functions.  (line   36)
  6129. * round up location counter:             Builtin Functions.  (line   36)
  6130. * runtime library name:                  Options.            (line  253)
  6131. * runtime library search path:           Options.            (line  884)
  6132. * runtime pseudo-relocation:             WIN32.              (line  128)
  6133. * scaled integers:                       Constants.          (line   12)
  6134. * scommon section:                       Input Section Common.
  6135.                                                              (line   20)
  6136. * script files:                          Options.            (line  428)
  6137. * scripts:                               Scripts.            (line    6)
  6138. * search directory, from cmd line:       Options.            (line  301)
  6139. * search path in linker script:          File Commands.      (line   71)
  6140. * SEARCH_DIR(PATH):                      File Commands.      (line   71)
  6141. * SECT (MRI):                            MRI.                (line  109)
  6142. * section address:                       Output Section Address.
  6143.                                                              (line    6)
  6144. * section address in expression:         Builtin Functions.  (line   17)
  6145. * section alignment, warnings on:        Options.            (line 1168)
  6146. * section data:                          Output Section Data.
  6147.                                                              (line    6)
  6148. * section fill pattern:                  Output Section Fill.
  6149.                                                              (line    6)
  6150. * section load address:                  Output Section LMA. (line    6)
  6151. * section load address in expression:    Builtin Functions.  (line  125)
  6152. * section name:                          Output Section Name.
  6153.                                                              (line    6)
  6154. * section name wildcard patterns:        Input Section Wildcards.
  6155.                                                              (line    6)
  6156. * section size:                          Builtin Functions.  (line  154)
  6157. * section, assigning to memory region:   Output Section Region.
  6158.                                                              (line    6)
  6159. * section, assigning to program header:  Output Section Phdr.
  6160.                                                              (line    6)
  6161. * SECTIONS:                              SECTIONS.           (line    6)
  6162. * sections, discarding:                  Output Section Discarding.
  6163.                                                              (line    6)
  6164. * segment origins, cmd line:             Options.            (line 1029)
  6165. * SEGMENT_START(SEGMENT, DEFAULT):       Builtin Functions.  (line  146)
  6166. * segments, ELF:                         PHDRS.              (line    6)
  6167. * shared libraries:                      Options.            (line  961)
  6168. * SHORT(EXPRESSION):                     Output Section Data.
  6169.                                                              (line    6)
  6170. * SIZEOF(SECTION):                       Builtin Functions.  (line  154)
  6171. * SIZEOF_HEADERS:                        Builtin Functions.  (line  170)
  6172. * small common symbols:                  Input Section Common.
  6173.                                                              (line   20)
  6174. * SORT:                                  Input Section Wildcards.
  6175.                                                              (line   58)
  6176. * SORT_BY_ALIGNMENT:                     Input Section Wildcards.
  6177.                                                              (line   54)
  6178. * SORT_BY_NAME:                          Input Section Wildcards.
  6179.                                                              (line   46)
  6180. * SQUAD(EXPRESSION):                     Output Section Data.
  6181.                                                              (line    6)
  6182. * stack size:                            Options.            (line 1589)
  6183. * standard Unix system:                  Options.            (line    7)
  6184. * start of execution:                    Entry Point.        (line    6)
  6185. * STARTUP(FILENAME):                     File Commands.      (line   79)
  6186. * strip all symbols:                     Options.            (line  415)
  6187. * strip debugger symbols:                Options.            (line  419)
  6188. * stripping all but some symbols:        Options.            (line  870)
  6189. * SUBALIGN(SUBSECTION_ALIGN):            Forced Input Alignment.
  6190.                                                              (line    6)
  6191. * suffixes for integers:                 Constants.          (line   12)
  6192. * symbol defaults:                       Builtin Functions.  (line  105)
  6193. * symbol definition, scripts:            Assignments.        (line    6)
  6194. * symbol names:                          Symbols.            (line    6)
  6195. * symbol tracing:                        Options.            (line  479)
  6196. * symbol versions:                       VERSION.            (line    6)
  6197. * symbol-only input:                     Options.            (line  404)
  6198. * symbols, from command line:            Options.            (line  679)
  6199. * symbols, relocatable and absolute:     Expression Section. (line    6)
  6200. * symbols, retaining selectively:        Options.            (line  870)
  6201. * synthesizing linker:                   Options.            (line  851)
  6202. * synthesizing on H8/300:                H8/300.             (line   14)
  6203. * TARGET(BFDNAME):                       Format Commands.    (line   35)
  6204. * TARGET1:                               ARM.                (line   27)
  6205. * TARGET2:                               ARM.                (line   32)
  6206. * thumb entry point:                     ARM.                (line   17)
  6207. * TI COFF versions:                      TI COFF.            (line    6)
  6208. * traditional format:                    Options.            (line 1008)
  6209. * unallocated address, next:             Builtin Functions.  (line  137)
  6210. * undefined symbol:                      Options.            (line  437)
  6211. * undefined symbol in linker script:     Miscellaneous Commands.
  6212.                                                              (line   13)
  6213. * undefined symbols, warnings on:        Options.            (line 1164)
  6214. * uninitialized data placement:          Input Section Common.
  6215.                                                              (line    6)
  6216. * unspecified memory:                    Output Section Data.
  6217.                                                              (line   39)
  6218. * usage:                                 Options.            (line  732)
  6219. * using a DEF file:                      WIN32.              (line   42)
  6220. * using auto-export functionality:       WIN32.              (line   22)
  6221. * Using decorations:                     WIN32.              (line   73)
  6222. * variables, defining:                   Assignments.        (line    6)
  6223. * verbose:                               Options.            (line 1064)
  6224. * version:                               Options.            (line  464)
  6225. * version script:                        VERSION.            (line    6)
  6226. * version script, symbol versions:       Options.            (line 1070)
  6227. * VERSION {script text}:                 VERSION.            (line    6)
  6228. * versions of symbols:                   VERSION.            (line    6)
  6229. * warnings, on combining symbols:        Options.            (line 1077)
  6230. * warnings, on section alignment:        Options.            (line 1168)
  6231. * warnings, on undefined symbols:        Options.            (line 1164)
  6232. * weak externals:                        WIN32.              (line  312)
  6233. * what is this?:                         Overview.           (line    6)
  6234. * wildcard file name patterns:           Input Section Wildcards.
  6235.                                                              (line    6)
  6236. * Xtensa options:                        Xtensa.             (line   56)
  6237. * Xtensa processors:                     Xtensa.             (line    6)
  6238.  
  6239.  
  6240. 
  6241. Tag Table:
  6242. Node: Top390
  6243. Node: Overview1154
  6244. Node: Invocation2268
  6245. Node: Options2676
  6246. Node: Environment74794
  6247. Node: Scripts76554
  6248. Node: Basic Script Concepts78288
  6249. Node: Script Format80995
  6250. Node: Simple Example81858
  6251. Node: Simple Commands84954
  6252. Node: Entry Point85405
  6253. Node: File Commands86164
  6254. Node: Format Commands90030
  6255. Node: Miscellaneous Commands91996
  6256. Node: Assignments94226
  6257. Node: Simple Assignments94682
  6258. Node: PROVIDE96418
  6259. Node: Source Code Reference97630
  6260. Node: SECTIONS101203
  6261. Node: Output Section Description103094
  6262. Node: Output Section Name104124
  6263. Node: Output Section Address105000
  6264. Node: Input Section106649
  6265. Node: Input Section Basics107450
  6266. Node: Input Section Wildcards109802
  6267. Node: Input Section Common114535
  6268. Node: Input Section Keep116017
  6269. Node: Input Section Example116507
  6270. Node: Output Section Data117475
  6271. Node: Output Section Keywords120252
  6272. Node: Output Section Discarding123821
  6273. Node: Output Section Attributes124777
  6274. Node: Output Section Type125706
  6275. Node: Output Section LMA126860
  6276. Node: Forced Input Alignment129130
  6277. Node: Output Section Region129510
  6278. Node: Output Section Phdr129940
  6279. Node: Output Section Fill130604
  6280. Node: Overlay Description131746
  6281. Node: MEMORY135994
  6282. Node: PHDRS140194
  6283. Node: VERSION145233
  6284. Node: Expressions152231
  6285. Node: Constants153072
  6286. Node: Symbols153633
  6287. Node: Location Counter154372
  6288. Node: Operators158668
  6289. Node: Evaluation159590
  6290. Node: Expression Section160954
  6291. Node: Builtin Functions162443
  6292. Node: Implicit Linker Scripts169935
  6293. Node: Machine Dependent170710
  6294. Node: H8/300171455
  6295. Node: i960173080
  6296. Node: ARM174765
  6297. Node: HPPA ELF32177225
  6298. Node: MMIX178848
  6299. Node: MSP430180065
  6300. Node: TI COFF181107
  6301. Node: WIN32181630
  6302. Node: Xtensa196220
  6303. Node: BFD199340
  6304. Node: BFD outline200795
  6305. Node: BFD information loss202081
  6306. Node: Canonical format204598
  6307. Node: Reporting Bugs208955
  6308. Node: Bug Criteria209649
  6309. Node: Bug Reporting210348
  6310. Node: MRI217373
  6311. Node: GNU Free Documentation License222016
  6312. Node: Index241725
  6313. 
  6314. End Tag Table
  6315.